Index of everything under docs/. Start with the root README for the product overview and quick start.
| Doc | Covers |
|---|---|
| ARCHITECTURE.md | System design: React client, Express server, PM2 satellites, PostgreSQL + data/ files |
| API.md | REST endpoints, complete route-domain index, Socket.IO events |
| STORAGE.md | Storage classification contract — PostgreSQL vs filesystem, new-data-store checklist |
| BACKUP.md | Filesystem snapshots + PostgreSQL dumps, restore semantics |
| PORTS.md | Port allocation (5553–5561) and how 5555/5553/5554 relate |
| PM2.md | Recommended PM2 ecosystem patterns for sub-projects |
| CONTRIBUTING.md | Dev setup (PostgreSQL required), code conventions |
| GITHUB_ACTIONS.md | CI and release workflows |
| VERSIONING.md | SemVer + release process (/do:release) |
| DEPS.md | Dependency audit — every third-party package and its verdict |
| TROUBLESHOOTING.md | Common runtime issues, known issues |
| GOALS_OPERATIONAL.md | Runtime operating principles the CoS agent reads (parsed by goalProgress.js) |
| SECURITY_AUDIT.md | Historical hardening audit (2026-02, all items resolved) |
App management: app-wizard · autofixer · browser · error-handling · jira-sprint-manager
Chief of Staff: chief-of-staff · cos-agent-runner · cos-enhancement · agent-skills · memory-system · claude-ollama · prompt-manager
Identity & self: digital-twin · identity-system · soul-system · cross-domain-insights-engine · post
Knowledge: brain-system · messages-security
Create: writers-room · cybercity-v2
Comms & voice: openclaw-operator-chat (pre-build audit) · voice
- plans/ — dated design plans (
YYYY-MM-DD-<slug>.md), archived on approval before implementation. Historical records, not living docs. - decisions/ — ADRs (
YYYY-MM-DD-<slug>.md), e.g. the Postgres-as-primary-datastore decision. - research/ — dated investigation and incident write-ups (e.g. the mflux GPU-watchdog panic).
- superpowers/ — plan/spec pairs from superpowers-driven builds:
specs/<date>-<slug>-design.md(design) +plans/<date>-<slug>.md(implementation plan).