Documentation Navigation
Use this file when you know your goal but not the right document.
For the canonical file map, start with INDEX.md.
Direction note:
- OpenClaw is the preferred daily front door
- this repo documents the specialist orchestrator sidecar and its bridge-backed runtime surfaces
- treat
/operatordocs as specialist-surface guidance, not a competing shell roadmap
When implementation changes materially, update the appropriate existing .md file in the same change set and cross-reference the relevant code/config paths where it helps prevent drift.
I Need Current Runtime Truth
I Need To Operate Or Deploy The System
- ../QUICKSTART.md
- OPENCLAW_KB/02_GATEWAY_AND_POLICY.md
- ../DEPLOYMENT.md
- operations/deployment.md
- guides/monitoring.md
- operations/backup-recovery.md
- operations/KNOWLEDGE_MIRROR_POLICY.md
I Need To Understand The Architecture
I Need Historical Cutover Context
Use Git history for the retired proof lane. The only in-repo historical doc that still matters for the current operator surface is:
I Need To Close Remaining Gaps
Sprint To Completion is the primary specialist-orchestrator execution tracker for unfinished repository work. Use it to finish the bounded runtime before taking on broader exposure work.
I Need To Extend The Runtime
- guides/adding-tasks.md
- guides/configuration.md
- guides/running-agents.md
- reference/api.md
- operations/KNOWLEDGE_MIRROR_POLICY.md
I Need Help Troubleshooting
I Found An Older "Complete" Or "Phase" Doc
Do not treat it as active truth first.
- Check operations/DOCUMENT_AUDIT.md
- Confirm whether the file is classified as canonical or historical
- Prefer code/config and the canonical docs listed in INDEX.md