Moxie Docs

什麼是 Moxie Docs？

Moxie Docs 是一套適用於 GitHub 儲存庫的文件系統，可自動產生並維護程式碼庫文件。它會索引 repo、建立可搜尋的架構、慣例與操作導覽文件，並在程式碼變更時重新檢查這些頁面，讓過時內容可被標示並重寫。

它也會透過 MCP 向 AI 工具提供 repo 慣例與已驗證情境，並以唯讀權限且範圍限於任務。此外，它還能每週開出一個僅文件的「Friday Cleanup」pull request，整理一週累積的偏移。

持續的儲存庫索引：Moxie 連接到 GitHub repo，並在發生合併時持續更新索引，讓文件始終對應最新程式碼。
自動生成、具來源引用的文件：它會產生含有指向來源程式碼引用的架構頁面、慣例與操作導覽，讓內容更容易驗證。
合併時偵測偏移：當程式碼變更影響既有文件時，Moxie 會標示偏移並重新生成相關頁面，而不是讓它們持續過時。
供 agents 使用的 MCP 情境：像 Cursor、Claude Code 與 Codex 這類 AI 工具可透過 MCP 取得慣例、文件與已驗證指令，而不必在每次提示時重新爬取 repo。
Friday Cleanup PRs：每週一次，Moxie 可開出僅文件的 pull request，彙整並呈現文件更新供審查。
PR 工作流程檢查：它可在合併前檢查 pull request 是否影響文件及描述是否一致，同時讓團隊保留程式碼變更與合併控制權。

先連接一個 GitHub repository。Moxie 會索引程式碼庫、生成第一批文件，並摘要可供人類或 AI agents 重複使用的慣例。

之後，團隊主要有兩種用法：審閱 Moxie 生成與更新的文件，並讓它檢查新的 pull request 是否有過時文件或描述不符的情況。若需要，coding agents 也可使用 MCP 整合，以範圍受限、唯讀的方式擷取 repo 專屬情境。

維持架構文件最新：團隊可維護像 webhook 行為或 billing 流程之類的頁面，當相關程式碼變更上線時由 Moxie 更新文件。
提供 coding agents repo 情境：使用 Cursor、Claude Code 或 Codex 的開發者，可直接取得慣例與已驗證指令，而不必手動瀏覽儲存庫。
每週審查文件偏移：想要固定清理節奏的團隊，可改為審查僅文件的 Friday Cleanup PR，而不是臨時追著過時頁面跑。
在合併前檢查 PR 影響：維護者可在 pull request 合併前查看是否影響文件，或是否需要改寫描述。
新工程師上手：新貢獻者可以在同一個工作區搜尋自動生成的文件與書籤，而不必閱讀多個來源檔案來理解慣例。

Moxie 會自動修改我的程式碼嗎？ 不會。來源說明中指出，程式碼變更仍由團隊控制。文件更新會以可供審查的僅文件 pull request 方式提供，而描述一致性的調整會修改 PR 描述，而不是程式碼。

連接 repository 之後會發生什麼？ Moxie 會索引 repo、生成可搜尋的文件、摘要慣例，並開始檢查新的 pull request 是否影響文件及描述是否一致。

存取 repository 有範圍限制嗎？ 有。產品描述指出，預設為唯讀存取，且以每個 repository 為範圍；MCP 情境也只限於任務，而非整個程式碼庫。

它會產生哪些類型的文件？ 此頁面特別提到架構頁面、慣例、操作導覽，以及像 billing webhooks 這類主題的文件。

它只支援 GitHub 嗎？ 此頁面是以 GitHub repositories 為撰寫對象，因此這裡描述的支援來源是 GitHub。

以 Markdown 或 docs wiki 進行手動文件撰寫：這是最簡單的替代方案，但無法自動依照程式碼重新檢查文件，也無法產生具來源引用的更新。
通用型程式碼搜尋與儲存庫瀏覽工具：這些工具有助於人員檢視檔案，但不提供維護中的文件層，或僅文件清理 PR。
沒有 repo-aware 文件的獨立 AI 程式碼助理：這些工具可以回答問題並編輯程式碼，但仍依賴模型重新探索情境，除非搭配像 Moxie 這樣的系統。
以 pull request 與審查為核心的內部文件流程：團隊可以透過 PR 手動管理文件，但必須自行建立並追蹤偏移檢查，而不是由程式碼庫自動產生。