Map of the documentation tree. For the project overview, see the main README.
| Path | What's there |
|---|---|
| hooks-and-ways/README.md | Start here — how the system works, reading paths by role |
| hooks-and-ways/ | Guides: creating ways, matching, macros, provenance, teams |
| hooks-and-ways.md | Reference: hook lifecycle, state management, session gating |
| architecture.md | System architecture diagrams (Mermaid) |
| architecture/ | Architecture Decision Records (managed by docs/scripts/adr) |
Two things named hooks-and-ways — they serve different layers:
hooks-and-ways/(directory) — guides for practitioners. "How do I create a way?" "How does matching work?"hooks-and-ways.md(file) — reference for contributors. Hook lifecycle, state diagrams, internal mechanics.
Same pattern: guide, reference, implementation.
- ../governance/README.md — guide. Getting started, operator commands.
- governance.md — reference. Compilation chain, data flow, tool mechanics.
- ../governance/ — implementation. Scripts, policies, manifests.
| Path | What's there |
|---|---|
| governance.md | Reference: compilation chain, data flow, tool internals |
| ../governance/README.md | Guide: getting started, operator commands |
| ../governance/policies/ | Policy source documents (governance chain targets) |
| hooks-and-ways/provenance.md | How-to: adding provenance to your ways |
| Path | What's there |
|---|---|
| prerequisites-*.md | Platform install guides (macOS, Arch, Debian, Fedora) |
| images/ | Theme imagery |