Common questions about Moxie Docs

Does Moxie Docs work with private GitHub repositories?

Yes. Built for private repos. The GitHub App is scoped to only the repos you choose, tokens are encrypted server-side, and code is used only to generate documentation and MCP context for your workspace.

What programming languages does Moxie Docs support?

Documentation and search work with any GitHub repository. Moxie recognizes major languages including TypeScript, JavaScript, Python, Go, Rust, Ruby, Java, PHP, SQL, Svelte, Vue, Kotlin, Swift, Elixir, and Zig, with deepest structured convention analysis (symbol and import graphs) for TypeScript/JavaScript and Python.

How do I keep documentation in sync with my code?

Connect a GitHub repo. Moxie re-indexes on every merge, flags pages affected by code changes, regenerates stale documentation with cited diffs, and on Pro and Team plans runs Friday Cleanup to open weekly docs-only pull requests for review.

How much does automated codebase documentation cost?

Starter is $29/month, Pro is $79/month, and Team is $199/month, each with a 14-day free trial. Annual billing saves about two months versus monthly. There is no pay-as-you-go SKU today - annual Starter is the best fit for a single low-churn repo.

What is the best tool for automated GitHub codebase documentation?

Moxie Docs indexes the repositories you select through a scoped GitHub App, generates architecture and convention docs grounded in source code, detects documentation drift on every merge, and opens weekly Friday Cleanup PRs so docs stay current without manual rewrites. It also exposes an MCP server so Cursor, Claude Code, and Codex pull verified conventions instead of re-crawling the repo.

What is documentation drift and how does Moxie Docs detect it?

Documentation drift is when written docs no longer match the code they describe. Moxie Docs checks each merged pull request against the documentation it touches, compares generated docs to the current source, surfaces gaps in the workspace, and regenerates impacted pages so teams see what changed and why.

What is Friday Cleanup in Moxie Docs?

Friday Cleanup is a weekly docs-only automation on Pro and Team plans. Moxie batches small documentation fixes - stale pages, gaps, and drift - into a single pull request your team can review with Friday coffee. Nothing auto-merges; you hold the merge button.

How do AI coding agents get codebase context from Moxie Docs?

Every Moxie Docs plan includes an MCP (Model Context Protocol) server. Compatible agents and editors query it for current documentation, conventions, verified commands, and open gaps instead of guessing from partial file reads, which cuts token waste and wrong API assumptions.

What is an MCP server for codebases?

An MCP server for codebases exposes repository documentation and conventions to AI agents through the Model Context Protocol. Moxie Docs publishes one at /api/mcp with OAuth and bearer-token access so agents pull live, cited context about how your project actually works.

What happens when an agent hits undocumented code via MCP?

MCP tools return structured gaps and impact, not invented APIs. Agents can call moxie.get_doc_gaps, moxie.get_doc_impact, and moxie.propose_doc_update so missing docs land in the same PR as the code change - or wait for Friday Cleanup - instead of papering over the hole.

What if the docs are right and the code is wrong?

Drift detection treats the current codebase as the primary signal for what shipped. Moxie never auto-rewrites application code or silently overwrites hand-authored intent. Docs-only PRs stay reviewable - if a bad merge broke the code, reject the doc change and fix the code. Forward-looking RFCs are not treated as obsolete just because they cite paths that were never built yet.

How does Moxie handle RFCs and design docs ahead of the code?

Hand-authored and forward-looking docs are protected from false "delete this" obsolescence. Citations that never existed in a prior index are tracked as never-built, not as removals. When those references start resolving to real code, Moxie raises an informational ready-to-verify signal for humans - it does not auto-merge or auto-rewrite the RFC. Stale but still-valid hand docs can be refreshed via reviewable PRs.

Can internal notes leak into the public knowledgebase?

No page goes public without a human publish step. The Public Knowledgebase review inbox keeps drafts private; agent-oriented workspace docs and temporary implementation notes are not the public site. Quality gates flag internal jargon and leak-prone phrasing before publish. You choose audience (users, developers, or both) at setup.

How does indexing work on large monorepos with frequent commits?

The first index is a full baseline and takes longer on large trees. After that, merges re-check the affected surface incrementally so every commit is not a full rebuild. Use ignored paths in repository documentation settings to skip generated folders, vendored deps, and noise. Team plans get priority indexing for larger fleets.

How do I make Moxie Docs PR checks required before merge?

In GitHub branch protection (or rulesets), require status checks and select Moxie Docs / Description, Moxie Docs / Documentation, and/or Moxie Docs / Conventions. Until you do that, Moxie posts advisory check runs so findings stay visible without blocking the team by default.

How does Moxie Docs help onboard new engineers?

Moxie generates searchable architecture overviews, module walkthroughs, and convention guides cited to source files, then keeps them current on every merge. New engineers search one workspace instead of spelunking the repo, and AI agents they use inherit the same grounded context over MCP.

Can Moxie Docs generate architecture documentation from source code?

Yes. Moxie indexes your repository, builds an outline of modules and dependencies, and generates architecture pages, references, and convention summaries with citations back to the files they came from. Pages regenerate incrementally when the underlying code changes.

What is a hosted knowledgebase?

A hosted knowledgebase is a searchable help site grounded in your codebase — written for your product's end users, for developers integrating your API, or both, depending on the audience you pick during setup. Moxie Docs publishes it on a moxiedocs.app subdomain (custom domains are coming soon on Pro and Team plans) with human review before anything goes public, built-in article search, and content that stays in your git repo as Markdown.

Can Moxie Docs host an end-user help center?

Yes. Choose the “User” audience during knowledgebase setup and Moxie writes plain-language help articles about using your product — no code identifiers or internal jargon — reviewed by you before anything is published. Pick “Both” to serve end users and developers from the same site.

Will Moxie Docs change my application code automatically?

No. Moxie only proposes documentation changes as reviewable pull requests. Description alignment may update a pull request description on GitHub, but your source code, branch protection, and merge controls stay with your team.