-
Notifications
You must be signed in to change notification settings - Fork 1
limitations
Have enough to write the page.
- README.md
RepoDocs is explicit about what it does not do. Per the README, "RepoDocs 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."
Sources: README.md:L129-L133
This means RepoDocs is a generation tool, not a hosting platform: the wiki artifacts it produces (Markdown pages, translated pages, wiki.html) must be published or hosted through some other mechanism the user controls (e.g. GitHub Wiki export via publish-wiki, or a static file host). It is also not a substitute for human code review — generated pages describe the code but do not vet it for correctness, quality, or security. Credential management for the underlying agent CLIs (LLM backends invoked as subprocesses) is left entirely to the user's own environment configuration.
Sources: README.md:L129-L133
The most significant caveat concerns the automated publishing safeguards. RepoDocs' publish command stages files in a temporary worktree, refuses to publish directly to main/master/trunk, scans generated output for private-key and token patterns, and requires an explicit --allow-public flag before anything is pushed publicly.
Sources: README.md:L113-L119
However, these protections are pattern-based and only catch secrets that match known token or key formats. The README warns directly: "Generated docs can still reveal sensitive source detail that matches no token pattern — review the dry-run file list before publishing a private repo's wiki." Because the LLM-generated pages summarize and quote real source code, business logic, internal architecture, or other non-credential-shaped sensitive information can end up in the output even when no secret-scanning pattern fires.
Sources: README.md:L116-L119
The recommended mitigation is procedural rather than automatic: always run --dry-run first and manually review the resulting file list before publishing a private repository's generated wiki.
Sources: README.md:L106-L119
A bare repodocs invocation is designed to print help rather than fail with a stack trace, but users should still expect long-running behavior: REPODOCS_JOBS (1–16, default 4) governs how many LLM subprocesses run in parallel, and REPODOCS_TIMEOUT bounds each individual subprocess. These are tunable limits, not guarantees of throughput or completion, and generation depends on the availability and behavior of an externally configured LLM backend.
Sources: README.md:L109-L111, README.md:L87-L87
The README does not document limitations regarding generation accuracy, hallucination, or supported languages beyond what is listed for translation; readers should not assume guarantees beyond what is stated above.
- Home
- Installation & Setup
- Architecture
- CLI Reference
- LLM Backend Selection
- Repository Scanning
- Wiki Page Planning
- Page Generation
- Source Citations
- Translation
- HTML Rendering
- Diagram Rendering
- Diagram Poster Tool
- Git Remote Link Resolution
- Publishing
- GitHub Wiki Integration
- Shared Utilities
- Environment Configuration
- Security & Trust Boundaries
- Limitations & Non-goals
- Testing
- Development
- Contributing
- Upgrading
- Changelog