Moxie Docs

Was ist Moxie Docs?

Moxie Docs ist ein Dokumentationssystem für GitHub-Repositories, das Codebase-Dokumentation automatisch generiert und pflegt. Es indexiert ein Repo, erstellt durchsuchbare Dokus für Architektur, Konventionen und Walkthroughs und prüft diese Seiten bei Codeänderungen erneut, damit veraltete Inhalte markiert und überarbeitet werden können.

Außerdem stellt es Repo-Konventionen und verifizierten Kontext KI-Tools über MCP bereit, mit auf die Aufgabe beschränktem Lesezugriff. Zusätzlich kann es wöchentlich einen Docs-only-Pull-Request „Friday Cleanup“ öffnen, um im Laufe der Woche angesammelte Abweichungen zusammenzuführen.

Hauptfunktionen

• Kontinuierliche Repository-Indexierung: Moxie verbindet sich mit einem GitHub-Repo und hält den Index bei Zusammenführungen aktuell, sodass die Dokumentation mit dem neuesten Code verknüpft bleibt.
• Generierte, quellengestützte Doku: Es erstellt Seiten für Architektur, Konventionen und Walkthroughs mit Verweisen auf den Quellcode, wodurch sich die Ergebnisse leichter überprüfen lassen.
• Drift-Erkennung beim Merge: Wenn Codeänderungen bestehende Doku betreffen, markiert Moxie die Abweichung und generiert die relevanten Seiten neu, statt sie veraltet zu lassen.
• MCP-Kontext für Agents: KI-Tools wie Cursor, Claude Code und Codex können Konventionen, Doku und verifizierte Befehle über MCP abrufen, ohne das Repo bei jeder Eingabe erneut zu crawlen.
• Friday-Cleanup-PRs: Einmal pro Woche kann Moxie einen Docs-only-Pull-Request öffnen, um Dokumentationsupdates zur Prüfung zusammenzustellen und anzuzeigen.
• PR-Workflow-Prüfungen: Es kann Pull Requests vor dem Merge auf Doku-Auswirkungen und Übereinstimmung der Beschreibung prüfen, während Codeänderungen und Merge-Kontrolle beim Team bleiben.

So verwenden Sie Moxie Docs

Beginnen Sie, indem Sie ein GitHub-Repository verbinden. Moxie indexiert die Codebase, erstellt den ersten Satz an Dokumentation und fasst Konventionen zusammen, die von Menschen oder KI-Agents wiederverwendet werden können.

Anschließend nutzen Teams es auf zwei Hauptwegen: Sie prüfen die von Moxie generierte und aktualisierte Doku und lassen neue Pull Requests auf veraltete Dokumentation oder nicht übereinstimmende Beschreibungen prüfen. Bei Bedarf kann die MCP-Integration von Coding-Agents genutzt werden, um Repo-spezifischen Kontext auf eingeschränkte, nur-lesende Weise abzurufen.

Anwendungsfälle

• Architekturdokumentation aktuell halten: Ein Team pflegt Seiten wie Webhook-Verhalten oder Billing-Flows, wobei Moxie die Doku aktualisiert, wenn dazugehörige Codeänderungen landen.
• Coding-Agents mit Repo-Kontext versorgen: Entwickler, die Cursor, Claude Code oder Codex verwenden, können Konventionen und verifizierte Befehle abrufen, ohne das Repository manuell zu durchsuchen.
• Dokumentationsdrift wöchentlich prüfen: Teams, die einen regelmäßigen Cleanup-Rhythmus wünschen, können den Docs-only-PR „Friday Cleanup“ prüfen, statt veraltete Seiten ad hoc nachzuverfolgen.
• PR-Auswirkungen vor dem Merge prüfen: Maintainer können sehen, ob ein Pull Request die Dokumentation betrifft oder eine Überarbeitung der Beschreibung erfordert, bevor er zusammengeführt wird.
• Neue Engineers einarbeiten: Neue Contributors können generierte Doku und Bookmarks in einem Workspace durchsuchen, statt mehrere Quellfiles lesen zu müssen, um Konventionen zu verstehen.

FAQ

Ändert Moxie meinen Code automatisch? Nein. Laut Quelle bleiben Codeänderungen unter Kontrolle des Teams. Dokumentationsupdates werden als prüfbare Docs-only-Pull-Requests bereitgestellt, und Anpassungen der Beschreibung aktualisieren die PR-Beschreibung statt den Code.

Was passiert, nachdem ich ein Repository verbunden habe? Moxie indexiert das Repo, generiert durchsuchbare Dokumentation, fasst Konventionen zusammen und beginnt, neue Pull Requests auf Doku-Auswirkungen und Übereinstimmung der Beschreibung zu prüfen.

Ist der Zugriff auf das Repository eingeschränkt? Ja. In der Produktbeschreibung heißt es, dass der Zugriff standardmäßig nur lesend und pro Repository beschränkt ist und der MCP-Kontext auf die Aufgabe statt auf die gesamte Codebase begrenzt ist.

Welche Arten von Dokumentation generiert es? Auf der Seite werden ausdrücklich Architektur-Seiten, Konventionen, Walkthroughs und Doku zu Themen wie Billing-Webhooks genannt.

Funktioniert es nur mit GitHub? Die Seite ist für GitHub-Repositories geschrieben, daher ist GitHub hier die beschriebene unterstützte Quelle.

Alternativen

• Manuelle Dokumentation in Markdown oder einem Docs-Wiki: Das ist die einfachste Alternative, aber die Dokumentation wird nicht automatisch gegen den Code überprüft und es werden keine quellengestützten Aktualisierungen generiert.
• Allgemeine Tools für Codesuche und Repository-Browsing: Diese helfen beim Prüfen von Dateien, bieten aber keine gepflegte Dokumentationsschicht oder Docs-only-Cleanup-PRs.
• Eigenständige KI-Coding-Assistenten ohne repo-bewusste Docs: Diese können Fragen beantworten und Code bearbeiten, sind aber weiterhin darauf angewiesen, dass das Modell den Kontext neu erschließt, sofern sie nicht mit einem System wie Moxie kombiniert werden.
• Interne Docs-Workflows auf Basis von Pull Requests und Review: Teams können Docs manuell über PRs verwalten, müssen Drift-Checks jedoch selbst erstellen und nachverfolgen, statt sie aus der Codebasis generieren zu lassen.