docs
Overview
Generates or refines a developer documentation set under generated-docs/. The command collects ontology, requirements, curated docs, and graph information, then asks an agent to produce structured Markdown. When the agent is unavailable, it writes a deterministic scaffold.
Usage
ouro docs create [--agent-model <model>]
ouro docs refine [--agent-model <model>]
Key Options
--agent-model <model>– Override the model used to draft or refine the documentation.
Inputs & Outputs
- Inputs:
.ouro/ontology/main.md,.ouro/requirements.md,.ouro/technologies/MAP.md,.ouro/graph.md, and any existing files withingenerated-docs/(forrefine). - Outputs: A structured documentation tree (technology, architecture, business, references) inside
generated-docs/, replacing previous files on each run.
When to Use
- Onboard engineers who need a concise narrative spanning architecture, requirements, and technology choices.
- Regenerate the documentation after significant knowledge base updates.
Follow-up Checklist
- Review diffs to ensure confidential information was not inadvertently captured.
- Commit the regenerated docs alongside the knowledge artefacts they reference.