Skip to content

docs: 优化自述文档、用户手册与主页排版及可读性 - #60

Merged
maguowei merged 3 commits into
mainfrom
dev
Oct 10, 2026
Merged

maguowei merged 3 commits into
mainfrom
dev

Conversation

@maguowei

Copy link
Copy Markdown
Owner

Summary

 documentation & site layout
 ├── README.md & README.zh-CN.md
-│   └── Dense capability walls, unformatted command lists, half-width punctuation issues
+│   └── Structured capability highlights, grouped make commands, strict fullwidth typography
 ├── docs/user-manual.md & docs/user-manual.zh-CN.md
-│   └── Wall-of-text sections, unstructured config subsections, mixed question mark styles
+│   └── Action-oriented workflows, bold lead answers for FAQs, 70/70 aligned bilingual headings
 └── site/index.html
-│   └── Outdated version badge (v0.20.1), unclosed language links, unlisted provider mentions
+│   └── Aligned version badge (v1.10.1), bilingual-closed doc links, verified provider lists
  • 自述文档(README):提炼首段定位,引入 > [!NOTE] 导读,将 14 项常用开发命令划分为「开发构建 / 检查测试 / 契约安全」三组,优化核心能力表与步骤指引。
  • 用户手册(User Manual):消除大段文字墙,为配置各分区建立加粗要点;规范 FAQ 核心结论与 5 大核心工作流分步说明;修复中文标点并保持中英文 70 级标题 100% 对齐。
  • 静态主页(Site):将主页版本号同步校准至 v1.10.1,实现文档链接同语言闭环,纠正非内置的供应商描述,补充每夜构建(Nightly)入口。

Evidence

  • Before:
    • README.zh-CN.md 存在 10+ 处半角逗号、括号与冒号混用,命令列表未分组。
    • docs/user-manual.zh-CN.md 存在大量半角问号(如 缺少 ANTHROPIC_AUTH_TOKEN?),FAQ 与配置项呈现密集大段文本。
    • site/index.html 停留于历史版本 v0.20.1,中文界面文档链接直接指向英文 Markdown。
  • After:
    • 运行 make docs-check 验证:
      node scripts/check-docs.mjs
      docs-check 通过:检查了 16 个 Markdown 文件。
      
    • 运行 git diff --check main..dev:通过(零空白符异常与格式警告)。

Merge Danger

Door: two-way

纯文档与静态页面展示优化,不涉及任何 Rust 后端逻辑、IPC 契约或前端组件逻辑变更,可随时快速回滚。

Blast Radius: Documentation

@maguowei
maguowei merged commit 933c16e into main Oct 10, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant