Back to Details

docs-knowledge-base

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Use this workflow when creating or editing files under

docs/knowledge-base/

.

当你创建或编辑

docs/knowledge-base/

下的文件时，请使用此工作流。

Audience and tone

受众与语气

Primary audience: human maintainers and contributors.
Secondary audience: AI agents reading project documentation.
Write concise, factual prose.
Avoid AI-specific annotations or prompt-oriented formatting.

主要受众：人工维护者和贡献者
次要受众：读取项目文档的AI Agent
编写简洁、基于事实的文字内容
避免使用AI专属注解或面向Prompt的格式

mdbook structure

mdbook结构

Keep chapter sources under
```
docs/knowledge-base/src/
```
.
Keep
```
docs/knowledge-base/src/SUMMARY.md
```
as the navigation source of truth.
When adding a new chapter, update
```
SUMMARY.md
```
in the same change.

章节源文件需保存在
```
docs/knowledge-base/src/
```
目录下
以
```
docs/knowledge-base/src/SUMMARY.md
```
作为导航的唯一真值来源
新增章节时，需在同一次变更中更新
```
SUMMARY.md
```

Chapter format

章节格式

One top-level heading (
```
#
```
) per chapter.
Prefer short sections with explicit responsibilities, invariants, and workflows.
Link related terms to
```
glossary.md
```
.
Link to relevant code paths when making concrete claims.

每个章节仅使用一个顶级标题（
```
#
```
）
优先采用短段落，明确说明职责、不变量和工作流
相关术语需链接到
```
glossary.md
```
提出具体主张时，链接到对应的代码路径

Writing conventions

编写规范

Follow semantic line breaks for prose.
Prefer active voice and operational wording.
Keep guidance implementation-neutral unless a path is repository-specific.
Clearly separate facts, constraints, and recommendations.

文字内容遵循语义换行规则
优先使用主动语态和可操作的表述
除非是仓库专属的路径，否则指南需保持实现无关
明确区分事实、约束和建议

Verification

验证

Before finishing, build the book and report the exact command and result:

bash

mdbook build docs/knowledge-base/

完成编辑前，请构建书籍并上报准确的命令和执行结果：

bash

mdbook build docs/knowledge-base/