Skip to content

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

  1. README.md -- the project overview.
  2. showcase/README.md -- the fidelity-badged public view (ADR 0017).
  3. architecture.md -- how the engine, server, and self-model fit together.
  4. state-machine.md -- the mission-posture FSM.
  5. tool-reference.md -- the seventeen-tool MCP surface (live VM may lag; see audit-2026-05-23.md ยง4).
  6. hardware-profiles.md -- the profile YAML schema, anchored to bom.md.
  7. adr/README.md -- numbered architecture decisions.
  8. stpa/README.md -- the safety analysis.
  9. backlog.md -- the BL-NNN tracker.
  10. deployment.md -- VM deployment guide.
  11. releasing.md -- release process.

Generated pages

A handful of pages are regenerated by scripts:

  • tool-reference.md from the FastMCP server.
  • adr/README.md from the ADR file headers.
  • backlog.md summary footer from the backlog table.

Run make schema to regenerate them.