limitations

Limitations & Non-goals

Relevant source files

• README.md

Non-goals

RepoDocs explicitly does not host generated wikis, replace source-code review, guarantee output is safe to publish without human review, or manage credentials for the agent CLIs it drives.

Sources: README.md:L172-L176

Publishing caveats

Publishing stages files in a temporary worktree, refuses to publish to main, master, or trunk, and scans output for private-key/token patterns, requiring an explicit --allow-public flag. The README stresses that generated docs can still reveal sensitive source detail that matches no token pattern, and instructs users to review the --dry-run file list before publishing a private repo's wiki. A publish-wiki command is also supported for GitHub Wiki export, subject to the same caveats.

Sources: README.md:L156-L162

Known caveat: GitHub mermaid rendering

GitHub's mermaid renderer intermittently fails to load diagrams inside wikis. RepoDocs ships an optional, separate tool (tools/diagram_poster.ts) to pre-render a mermaid block into a pastel PNG poster that can be committed into the <repo>.wiki.git repository and referenced with standard Markdown image syntax, sidestepping the renderer failures. This tool is not part of RepoDocs's zero-dependency core: it requires Bun, Playwright, and a Chromium browser download (~150 MB) — dependencies the core pipeline does not need.

Sources: README.md:L103-L117

Zero-dependency scope

The core pipeline promises zero runtime dependencies beyond the Python standard library, and generation itself depends on the user having a logged-in backend CLI (Claude Code, OMP, or Codex) plus internet access for that backend's API, for graphify, and for git. graphify (the knowledge-graph tool used to sharpen planning) is optional and can be skipped with --no-graph, at the cost of less-informed page planning.

Sources: README.md:L79-L96

Backend constraints

Each backend runs read-only — restricted to read/grep/glob tools — with no session persistence across runs, and RepoDocs relies entirely on the user's own CLI login (Claude Code, OMP, or Codex) rather than providing its own model access.

Sources: README.md:L130-L138