Documentation index¶
This tree is the source for the MkDocs site published at
https://rmednitzer.github.io/nous/. The top-level navigation lives in
mkdocs.yml.
Reading order¶
- README.md -- the project overview.
- showcase/README.md -- the fidelity-badged public view (ADR 0017).
- architecture.md -- how the engine, server, and self-model fit together.
- state-machine.md -- the mission-posture FSM.
- tool-reference.md -- the seventeen-tool MCP surface (live VM may lag; see audit-2026-05-23.md ยง4).
- hardware-profiles.md -- the profile YAML schema, anchored to bom.md.
- adr/README.md -- numbered architecture decisions.
- stpa/README.md -- the safety analysis.
- backlog.md -- the BL-NNN tracker.
- deployment.md -- VM deployment guide.
- releasing.md -- release process.
Generated pages¶
A handful of pages are regenerated by scripts:
tool-reference.mdfrom the FastMCP server.adr/README.mdfrom the ADR file headers.backlog.mdsummary footer from the backlog table.
Run make schema to regenerate them.