Start with the structure
Index repository entities and relationships. Generate architecture and reference pages with the scaffold command before adding an LLM to the workflow.
IT product documentation generator
Your code has a map. Your team should have one too.
Turn a repository into architecture maps, module references and documentation you can update as the code changes. Follow the development of RepoDocs.
CLI tools exist today. Cloud access is in development.
$ repodocs scaffold .
architecture / reference / overview
architecture / reference / overview
checkout-servicerepository
payments/
orders/
Architecture overview.md
CODE → STRUCTURE → DOCSILLUSTRATION
A map for the next teammate.
Repository indexingArchitecture & referenceChange impactCLI-first
01 / THE WORKFLOW
Make the repository readable.
A repository tells you what exists. Documentation helps your team understand how it fits together.
Give the next teammate a map
Connect module references, architecture notes and an overview in a documentation site your team can read and review.
Follow the changes
Use CLI analysis and CI commands to inspect change impact and refresh documentation alongside repository changes.
02 / REAL CLI WORKFLOW
From source tree to shared context.
The CLI is the current product. The example below separates structural scaffolding from LLM-assisted generation.
repodocs init . repodocs scaffold . repodocs index . repodocs update .
WHAT IS AVAILABLE TODAY
Index. Scaffold. Update.
The scaffold command produces architecture and reference pages without an LLM. The update workflow uses your configured model. CI commands support change-impact analysis.
Read the reproducible example ↗Commands shown from the current CLI source. Results depend on language support, configuration and model access.
FIELD NOTES
Go one level deeper.
Repository documentation generator: start with the code
A practical workflow for turning a repository into architecture and reference documentation with the RepoDocs CLI.
Read the guide ↗Architecture documentation that leads back to source files
Use generated repository maps as a starting point for architecture documentation, then add the decisions a parser cannot know.
Read the guide ↗Documentation in CI: make code changes easier to review
A practical approach to checking generated documentation and reviewing change impact in a repository workflow.
Read the guide ↗FOLLOW THE BUILD
Get the next chapter.
Product updates, new documentation examples and news about cloud access. Subscribe by email when the mailing list opens.
What is the current release status?
RepoDocs currently has a Rust CLI implementation for repository indexing, scaffolding, updates and CI workflows. A hosted cloud product is in development. This site collects interest in updates; it does not provide repository upload or paid cloud access.