docs: add deep-dive cross-links and trim duplication
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user