用途:为 beads 用户文档(docs/ 下的 Mintlify 站点)提供统一的写作、编辑、重构与审阅规范,面向安装 bd、跟踪工作并同步的用户(人或智能体)。贡献者文档在 engdocs/ 与 AGENTS.md,规则不同。
主要能力与要求:
- 统一术语:使用 bead/issue、ready work、proto、molecule、formula、gate、sync(Dolt push/pull)、embedded mode/server mode、federation、hash ID 等,避免 task、template、mol、barrier 等替代说法。
- 内容立场:先讲问题与价值,再讲机制;不写项目历史、内部包路径或版本门槛;用具体 bd 调用与输出代替抽象描述。
- 信息架构:导航在 docs/docs.json;每个章节有 Overview 索引页;一页一用途;概念统一链接到 docs/core-concepts/index.md。
- 排版:正文不用 # H1;链接用根相对无扩展名形式;Mintlify 按 MDX 解析,尖括号占位符需放在反引号内;组件少用。
- 图表:优先 Mermaid;复杂图用 Excalidraw 管线,源文件在 docs/diagrams/excalidraw/,用 make diagrams-excalidraw 渲染,嵌入 /diagrams/excalidraw-rendered/<name>.svg,需渲染检查并获维护者批准。
- 生成内容:docs/cli-reference/*.md、docs/docs.json 中的 CLI Reference 页数组、docs/CLI_REFERENCE.md 均由 bd 与 tools/docsmint 生成,禁止手改;改措辞需改 Go 源码并运行 ./scripts/generate-cli-docs.sh。文档描述固定发布版本,由 docs/cli-docs.pin 指定。
- 验证:运行 go test ./test/docsync、./scripts/generate-cli-docs.sh --check、./scripts/check-doc-freshness.sh,并用 make docs-dev 或 ./mint.sh dev 在 localhost:3000 预览。移动或删除页面需加重定向、全仓改写入站链接并检查 bd 是否打印旧路径。
- 流程:作者撰写,维护者审阅,明确批准后提交;按受众分组提交;文档工作按 AGENTS.md 以 bd issue 跟踪。
限制:资料未提供具体收费、价格、平台支持范围或效果数据;上述命令与路径需按实际仓库环境执行。