Moxie Docs

什么是 Moxie Docs？

Moxie Docs 是一套面向 GitHub 仓库的文档系统，可自动生成并维护代码库文档。它会索引仓库，生成可搜索的架构、规范和操作说明文档，并在代码变更时重新检查这些页面，以便标记并重写过时内容。

它还通过 MCP 向 AI 工具暴露仓库规范和已验证上下文，并将访问范围限制为只读且仅限当前任务。此外，它可以每周发起一个仅文档的“Friday Cleanup”拉取请求，用于汇总一周积累的漂移。

主要功能

• 持续仓库索引：Moxie 连接到 GitHub 仓库，并在合并发生时保持索引更新，使文档始终关联最新代码。
• 自动生成、带来源引用的文档：它会生成架构页面、规范和操作说明，并附上指向源代码的引用，便于验证。
• 合并时检测漂移：当代码变更影响现有文档时，Moxie 会标记漂移并重新生成相关页面，而不是让它们继续过时。
• 面向 agent 的 MCP 上下文：Cursor、Claude Code 和 Codex 等 AI 工具可以通过 MCP 拉取规范、文档和已验证命令，而无需在每次提示时重新爬取仓库。
• Friday Cleanup PR：Moxie 每周可创建一个仅文档的拉取请求，汇总并呈现文档更新供审阅。
• PR 工作流检查：它可以在合并前检查拉取请求对文档的影响及描述是否一致，同时将代码更改和合并控制权保留给团队。

如何使用 Moxie Docs

先连接一个 GitHub 仓库。Moxie 会索引代码库，生成首批文档，并总结可供人或 AI agent 复用的规范。

之后，团队主要以两种方式使用它：审阅 Moxie 生成和更新的文档，以及让它检查新的拉取请求是否存在文档过时或描述不匹配的问题。如有需要，编码 agent 还可以通过 MCP 集成，以受限、只读的方式获取仓库特定上下文。

使用场景

• 保持架构文档最新：团队维护如 webhook 行为或计费流程等页面，当相关代码变更落地时，Moxie 会更新文档。
• 为编码 agent 提供仓库上下文：使用 Cursor、Claude Code 或 Codex 的开发者，无需手动浏览仓库即可获取规范和已验证命令。
• 每周审查文档漂移：希望固定清理节奏的团队，可以审阅仅文档的 Friday Cleanup PR，而不是临时追着过时页面处理。
• 在合并前检查 PR 影响：维护者可以在拉取请求合并前查看它是否影响文档，或是否需要重写描述。
• 新工程师入职：新贡献者可以在一个工作区内搜索生成的文档和书签，而无需阅读多个源文件来理解规范。

常见问题

Moxie 会自动修改我的代码吗？
不会。源描述说明代码更改仍由团队控制。文档更新会以可审阅的仅文档拉取请求形式交付，而描述一致性调整的是 PR 描述，而不是代码。

连接仓库后会发生什么？
Moxie 会索引仓库，生成可搜索文档，总结规范，并开始检查新的拉取请求是否影响文档及描述是否一致。

对仓库的访问是否有范围限制？
是的。产品描述说明默认是只读访问，并且按仓库限制范围；MCP 上下文也仅限于当前任务，而不是整个代码库。

它会生成哪些类型的文档？
该页面明确提到会生成架构页面、规范、操作说明，以及诸如计费 webhook 之类主题的文档。

它只支持 GitHub 吗？
该页面是针对 GitHub 仓库编写的，因此这里描述的支持源就是 GitHub。

替代方案

• 使用 Markdown 或 docs wiki 进行手动文档维护：这是最简单的替代方案，但它不会自动将文档与代码重新核对，也不会生成带来源引用的更新。
• 通用代码搜索和仓库浏览工具：这类工具有助于查看文件，但不会提供受维护的文档层或仅文档清理 PR。
• 不具备仓库感知文档的独立 AI 编码助手：这类工具可以回答问题并编辑代码，但除非配合 Moxie 这类系统，否则仍依赖模型重新发现上下文。
• 围绕 pull request 和审查构建的内部文档流程：团队可以通过 PR 手动管理文档，但必须自行创建和跟踪漂移检查，而不是由代码库自动生成。