From 73d296633244d6965e10cdc4e394fd753234983d Mon Sep 17 00:00:00 2001 From: Abhimanyu Saharan Date: Wed, 11 Feb 2026 06:30:08 +0000 Subject: [PATCH] docs: add deep-dive cross-links and trim duplication --- docs/03-development.md | 4 ++++ docs/05-architecture.md | 13 +++++-------- docs/07-api-reference.md | 4 ++++ docs/08-agents-and-skills.md | 9 +++++---- docs/09-ops-runbooks.md | 12 ++++++------ docs/10-troubleshooting.md | 6 ++++-- docs/11-contributing.md | 5 +++++ 7 files changed, 33 insertions(+), 20 deletions(-) diff --git a/docs/03-development.md b/docs/03-development.md index fe9944fb..be7d8db4 100644 --- a/docs/03-development.md +++ b/docs/03-development.md @@ -1,5 +1,9 @@ # Development +## Deep dives + +- [Testing guide](testing/README.md) + This is the contributor-focused dev workflow for the Mission Control repo. ## Prereqs diff --git a/docs/05-architecture.md b/docs/05-architecture.md index 19be7009..99f2af80 100644 --- a/docs/05-architecture.md +++ b/docs/05-architecture.md @@ -1,5 +1,10 @@ # Architecture +## Deep dives + +- [Architecture deep dive](architecture/README.md) +- [Gateway protocol](openclaw_gateway_ws.md) + Mission Control is the **web UI + HTTP API** for operating OpenClaw. It’s where you manage boards, tasks, agents, approvals, and (optionally) gateway connections. > Auth note: **Clerk is required for now** (current product direction). The codebase includes gating so CI/local can run with placeholders, but real deployments should configure Clerk. @@ -49,11 +54,3 @@ Automation/agents can use the “agent API surface”: - Auth via `X-Agent-Token`. See: `backend/app/api/agent.py`, `backend/app/core/agent_auth.py`. - -## Links to deeper docs - -- Existing deep-dive: `docs/architecture/README.md` -- Deployment: [docs/deployment/README.md](deployment/README.md) -- Production notes: [docs/production/README.md](production/README.md) -- Gateway protocol: [docs/openclaw_gateway_ws.md](openclaw_gateway_ws.md) - diff --git a/docs/07-api-reference.md b/docs/07-api-reference.md index db5c064e..633ad5b2 100644 --- a/docs/07-api-reference.md +++ b/docs/07-api-reference.md @@ -1,5 +1,9 @@ # API reference (first pass) +## Deep dives + +- [Gateway WebSocket protocol (API-ish)](openclaw_gateway_ws.md) + This is a **map** of the Mission Control HTTP API surface. It’s intentionally light-weight for the first pass. ## Base diff --git a/docs/08-agents-and-skills.md b/docs/08-agents-and-skills.md index 67c15cd4..17121549 100644 --- a/docs/08-agents-and-skills.md +++ b/docs/08-agents-and-skills.md @@ -1,5 +1,10 @@ # Agents & skills +## Deep dives + +- [Gateway protocol](openclaw_gateway_ws.md) +- [Gateway base config](openclaw_gateway_base_config.md) + This page explains the automation model as it appears in Mission Control. ## Agent lifecycle (conceptual) @@ -19,9 +24,5 @@ This page explains the automation model as it appears in Mission Control. - required binaries/services - command patterns -## Where this connects in the repo -- Gateway protocol: [docs/openclaw_gateway_ws.md](openclaw_gateway_ws.md) -- Gateway base config: [docs/openclaw_gateway_base_config.md](openclaw_gateway_base_config.md) - ## Next - Add repo-specific guidance for authoring skills and where they live (once standardized). diff --git a/docs/09-ops-runbooks.md b/docs/09-ops-runbooks.md index 1d8a6f80..6e29fddc 100644 --- a/docs/09-ops-runbooks.md +++ b/docs/09-ops-runbooks.md @@ -1,11 +1,12 @@ # Ops / runbooks -This page is the operator/SRE entry point. It intentionally links to existing deeper docs to minimize churn. +## Deep dives -## Where to start -- Deployment: [docs/deployment/README.md](deployment/README.md) -- Production checklist/notes: [docs/production/README.md](production/README.md) -- Troubleshooting: [docs/troubleshooting/README.md](troubleshooting/README.md) +- [Deployment](deployment/README.md) +- [Production](production/README.md) +- [Troubleshooting](troubleshooting/README.md) + +This page is the operator/SRE entry point. It intentionally links to existing deeper docs to minimize churn. ## “First 30 minutes” incident checklist @@ -34,4 +35,3 @@ This page is the operator/SRE entry point. It intentionally links to existing de ## Backups / restore (placeholder) - Define backup cadence and restore steps once production deployment is finalized. - diff --git a/docs/10-troubleshooting.md b/docs/10-troubleshooting.md index 6e4c7bd4..8f13590e 100644 --- a/docs/10-troubleshooting.md +++ b/docs/10-troubleshooting.md @@ -1,8 +1,10 @@ # Troubleshooting -This is the high-level troubleshooting entry point (minimal churn). +## Deep dives -- Deep-dive troubleshooting: [docs/troubleshooting/README.md](troubleshooting/README.md) +- [Troubleshooting deep dive](troubleshooting/README.md) + +This is the high-level troubleshooting entry point (minimal churn). ## Quick triage diff --git a/docs/11-contributing.md b/docs/11-contributing.md index b4771900..36a204d7 100644 --- a/docs/11-contributing.md +++ b/docs/11-contributing.md @@ -1,5 +1,10 @@ # Contributing +## Deep dives + +- [Coverage policy](coverage-policy.md) +- [Testing guide](testing/README.md) + ## How to contribute (first pass) - Follow the repo’s existing PR and review conventions. - Prefer small PRs.