Skip to content

Commit 8dbc3a3

Browse files
WitMiaoWitMiao
committed
docs(gitbook): significantly expand zh-CN documentation with comprehensive guides
- Restructure getting-started section for better clarity - Merge installation, first-run, and quickstart into unified guide - Remove redundant separate files - Update SUMMARY.md to reflect simplified structure - Massively enhance documentation content across all sections - Advanced: Add detailed guides for API providers, configuration, i18n, templates, troubleshooting - Best practices: Expand output styles, tips, and worktree workflows - CLI: Complete comprehensive command references for all tools - Development: Detail architecture, contributing guidelines, and testing - Features: Add in-depth explanations for all ZCF features - Workflows: Provide complete workflow documentation with examples - Documentation improvements include: - Detailed examples and code snippets for all features - Comprehensive troubleshooting sections - Best practice recommendations and usage patterns - Multi-platform support details (Windows/macOS/Linux/WSL/Termux) - Complete API reference and configuration options - Step-by-step guides for common scenarios This comprehensive update transforms the documentation from basic outlines to complete user guides, significantly improving user experience and onboarding.
1 parent 387b8ef commit 8dbc3a3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+11763
-596
lines changed

‎gitbook/zh-CN/README.md‎

Lines changed: 52 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,43 @@ layout:
1616
visible: true
1717
---
1818

19-
# ZCF - Zero-Config Code Flow
19+
[![npm version][npm-version-src]][npm-version-href]
20+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
21+
[![License][license-src]][license-href]
22+
[![Claude Code][claude-code-src]][claude-code-href]
23+
[![codecov][codecov-src]][codecov-href]
24+
[![JSDocs][jsdocs-src]][jsdocs-href]
25+
[![Ask DeepWiki][deepwiki-src]][deepwiki-href]
26+
27+
<div data-full-width="true" style="text-align: center;">
28+
<figure>
29+
<img src="https://raw.githubusercontent.com/UfoMiao/zcf/main/src/assets/banner.webp" alt="ZCF Banner" style="width: 80%; margin: 0 auto; display: block;"/>
30+
<figcaption></figcaption>
31+
</figure>
32+
</div>
2033

2134
<div align="center">
35+
<h1>
36+
ZCF - Zero-Config Code Flow
37+
</h1>
2238

23-
**零配置，一键完成 Claude Code 与 Codex 全栈工作环境搭建**
39+
<p align="center">
40+
> 零配置，一键完成 Claude Code 与 Codex 全栈工作环境搭建 - 涵盖多语言配置、智能工作流、MCP 服务集成、状态栏与 CLI 命令体系
41+
</p>
42+
</div>
2443

25-
涵盖多语言配置、智能工作流、MCP 服务集成、状态栏与 CLI 命令体系
44+
## ♥️ 赞助商 AI API
2645

27-
</div>
46+
<a href="https://share.302.ai/gAT9VG">
47+
<div data-full-width="true" style="text-align: center;">
48+
<figure>
49+
<img src="https://raw.githubusercontent.com/UfoMiao/zcf/main/src/assets/302.ai.jpg" alt="赞助商 AI API" style="width: 100%; margin: 0 auto; display: block;"/>
50+
<figcaption></figcaption>
51+
</figure>
52+
</div>
53+
</a>
54+
55+
[302.AI](https://share.302.ai/gAT9VG) 是一个按用量付费的企业级AI资源平台，提供市场上最新、最全面的AI模型和API，以及多种开箱即用的在线AI应用。
2856

2957
## 项目概述
3058

@@ -39,7 +67,7 @@ ZCF（Zero-Config Code Flow）是一个面向专业开发者的 CLI 工具，目
3967
- **可视化状态与运维**：包含 CCR（Claude Code Router）配置助手以及 CCometixLine 状态栏安装与升级能力。
4068
- **可扩展配置体系**：支持多 API 配置并行、输出风格切换、环境权限导入、模板与语言分离管理。
4169

42-
## 安装后你将获得什么
70+
## 使用 ZCF 你将获得什么
4371

4472
> 完整内容来自 `zcf-intr.md` 并结合最新特性补充。
4573
@@ -50,16 +78,6 @@ ZCF（Zero-Config Code Flow）是一个面向专业开发者的 CLI 工具，目
5078
5. **MCP 服务基座**：一键启用主流 MCP Server，并根据是否需要 API Key 智能提示环境变量要求。
5179
6. **辅助工具链**：CCometixLine 状态栏自动安装、CCR 管理菜单、Codex CLI 安装/升级、使用数据统计。
5280

53-
## 快速导航
54-
55-
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody>
56-
<tr><td><strong>快速开始</strong></td><td>安装与首次运行</td><td></td><td><a href="getting-started/README.md">README.md</a></td></tr>
57-
<tr><td><strong>核心特性</strong></td><td>环境、工作流、MCP、Codex</td><td></td><td><a href="features/README.md">README.md</a></td></tr>
58-
<tr><td><strong>CLI 命令</strong></td><td>zcf 指令详解</td><td></td><td><a href="cli/README.md">README.md</a></td></tr>
59-
<tr><td><strong>工作流体系</strong></td><td>六阶段 / Feat / BMad</td><td></td><td><a href="workflows/README.md">README.md</a></td></tr>
60-
<tr><td><strong>最佳实践</strong></td><td>输出风格、Worktree</td><td></td><td><a href="best-practices/README.md">README.md</a></td></tr>
61-
<tr><td><strong>深入开发</strong></td><td>架构、贡献、测试</td><td></td><td><a href="development/README.md">README.md</a></td></tr>
62-
</tbody></table>
6381

6482
## 适用人群
6583

@@ -71,8 +89,25 @@ ZCF（Zero-Config Code Flow）是一个面向专业开发者的 CLI 工具，目
7189

7290
- **官方文档站**：<https://zcf.ufomiao.top>
7391
- **中文文档入口**：<https://zcf.ufomiao.top/docs/zh-cn>
74-
- **GitHub**：<https://github.com/ufomiao/zcf>
92+
- **GitHub**：<https://github.com/UfoMiao/zcf>
7593
- **npm**：<https://www.npmjs.com/package/zcf>
76-
- **更新日志**：`CHANGELOG.md`
94+
- **更新日志**：[CHANGELOG.md](https://github.com/UfoMiao/zcf/blob/main/CHANGELOG.md)
7795

7896
> 若需英文或日文文档，请在中文文档确认后提交翻译需求。
97+
98+
<!-- Badges -->
99+
100+
[npm-version-src]: https://img.shields.io/npm/v/zcf?style=flat&colorA=080f12&colorB=1fa669
101+
[npm-version-href]: https://npmjs.com/package/zcf
102+
[npm-downloads-src]: https://img.shields.io/npm/dm/zcf?style=flat&colorA=080f12&colorB=1fa669
103+
[npm-downloads-href]: https://npmjs.com/package/zcf
104+
[license-src]: https://img.shields.io/github/license/ufomiao/zcf.svg?style=flat&colorA=080f12&colorB=1fa669
105+
[license-href]: https://github.com/UfoMiao/zcf/blob/main/LICENSE
106+
[claude-code-src]: https://img.shields.io/badge/Claude-Code-1fa669?style=flat&colorA=080f12&colorB=1fa669
107+
[claude-code-href]: https://claude.ai/code
108+
[codecov-src]: https://codecov.io/gh/UfoMiao/zcf/graph/badge.svg?token=HZI6K4Y7D7&style=flat&colorA=080f12&colorB=1fa669
109+
[codecov-href]: https://codecov.io/gh/UfoMiao/zcf
110+
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-1fa669?style=flat&colorA=080f12&colorB=1fa669
111+
[jsdocs-href]: https://www.jsdocs.io/package/zcf
112+
[deepwiki-src]: https://img.shields.io/badge/Ask-DeepWiki-1fa669?style=flat&colorA=080f12&colorB=1fa669
113+
[deepwiki-href]: https://deepwiki.com/UfoMiao/zcf

‎gitbook/zh-CN/SUMMARY.md‎

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,56 @@
11
# 目录
22

3-
* [项目介绍](README.md)
3+
* [🚀 项目介绍](README.md)
44

5-
## 快速开始
6-
* [快速开始概览](getting-started/README.md)
7-
* [安装指南](getting-started/installation.md)
8-
* [首次运行](getting-started/first-run.md)
9-
* [快速上手示例](getting-started/quickstart.md)
5+
## 开始使用
6+
* [⚡ 快速开始](getting-started/README.md)
7+
* [📖 使用指南](getting-started/installation.md)
108

119
## 功能特性
12-
* [功能总览](features/README.md)
13-
* [Claude Code 配置能力](features/claude-code.md)
14-
* [Codex 支持](features/codex.md)
15-
* [工作流系统](features/workflows.md)
16-
* [MCP 服务集成](features/mcp.md)
17-
* [Claude Code Router](features/ccr.md)
18-
* [CCometixLine 状态栏](features/cometix.md)
19-
* [多配置与备份](features/multi-config.md)
10+
* [📋 功能总览](features/README.md)
11+
* [⚙️ Claude Code 配置能力](features/claude-code.md)
12+
* [🔧 Codex 支持](features/codex.md)
13+
* [🔄 工作流系统](features/workflows.md)
14+
* [🔌 MCP 服务集成](features/mcp.md)
15+
* [🌐 Claude Code Router](features/ccr.md)
16+
* [📊 CCometixLine 状态栏](features/cometix.md)
17+
* [💾 多配置与备份](features/multi-config.md)
2018

2119
## 进阶指南
22-
* [进阶指南](advanced/README.md)
23-
* [配置管理](advanced/configuration.md)
24-
* [API 提供商预设](advanced/api-providers.md)
25-
* [模板与输出风格](advanced/templates.md)
26-
* [国际化与语言](advanced/i18n.md)
27-
* [故障排除](advanced/troubleshooting.md)
20+
* [📖 进阶指南](advanced/README.md)
21+
* [⚙️ 配置管理](advanced/configuration.md)
22+
* [🔑 API 提供商预设](advanced/api-providers.md)
23+
* [🎨 模板与输出风格](advanced/templates.md)
24+
* [🌍 国际化与语言](advanced/i18n.md)
25+
* [🔍 故障排除](advanced/troubleshooting.md)
2826

2927
## CLI 命令
30-
* [命令概览](cli/README.md)
31-
* [zcf init](cli/init.md)
32-
* [zcf update](cli/update.md)
33-
* [主菜单](cli/menu.md)
34-
* [CCR 代理管理](cli/ccr.md)
35-
* [使用分析 ccu](cli/ccu.md)
36-
* [卸载与清理](cli/uninstall.md)
37-
* [配置切换](cli/config-switch.md)
38-
* [版本检查](cli/check-updates.md)
28+
* [📋 命令概览](cli/README.md)
29+
* [🎯 zcf init](cli/init.md)
30+
* [🔄 zcf update](cli/update.md)
31+
* [📱 主菜单](cli/menu.md)
32+
* [🌐 CCR 代理管理](cli/ccr.md)
33+
* [📊 使用分析 ccu](cli/ccu.md)
34+
* [🗑️ 卸载与清理](cli/uninstall.md)
35+
* [🔄 配置切换](cli/config-switch.md)
36+
* [🔍 版本检查](cli/check-updates.md)
3937

4038
## 工作流详解
41-
* [工作流概览](workflows/README.md)
42-
* [ZCF 六阶段工作流](workflows/zcf-workflow.md)
43-
* [功能开发工作流](workflows/feat.md)
44-
* [BMad 敏捷流程](workflows/bmad.md)
45-
* [Spec 工作流集成](workflows/spec.md)
46-
* [Git 智能命令](workflows/git-commands.md)
39+
* [📋 工作流概览](workflows/README.md)
40+
* [🔄 ZCF 六阶段工作流](workflows/zcf-workflow.md)
41+
* [✨ 功能开发工作流](workflows/feat.md)
42+
* [🏃 BMad 敏捷流程](workflows/bmad.md)
43+
* [📝 Spec 工作流集成](workflows/spec.md)
44+
* [🌲 Git 智能命令](workflows/git-commands.md)
4745

4846
## 最佳实践
49-
* [最佳实践](best-practices/README.md)
50-
* [使用技巧](best-practices/tips.md)
51-
* [Worktree 并行开发](best-practices/worktree.md)
52-
* [输出风格策略](best-practices/output-styles.md)
47+
* [⭐ 最佳实践](best-practices/README.md)
48+
* [💡 使用技巧](best-practices/tips.md)
49+
* [🌳 Worktree 并行开发](best-practices/worktree.md)
50+
* [🎨 输出风格策略](best-practices/output-styles.md)
5351

5452
## 开发文档
55-
* [面向贡献者](development/README.md)
56-
* [贡献指南](development/contributing.md)
57-
* [架构说明](development/architecture.md)
58-
* [测试指南](development/testing.md)
53+
* [👋 面向贡献者](development/README.md)
54+
* [📝 贡献指南](development/contributing.md)
55+
* [🏗️ 架构说明](development/architecture.md)
56+
* [🧪 测试指南](development/testing.md)

‎gitbook/zh-CN/advanced/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
---
2+
icon: book
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
---
18+
119
# 进阶指南
220

321
本章聚焦于高级配置、模板管理、国际化与故障排除。适合需要大规模部署、团队协作或深度定制的用户。

0 commit comments

Comments
 (0)