yunxiafei/openclaw-mission-control
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: replace code-formatted doc paths with markdown links

Browse Source
This commit is contained in:
Abhimanyu Saharan
2026-02-11 10:40:02 +00:00
parent f523415fc8
commit 4c206fb97d
10 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -10,9 +10,9 @@ This repo welcomes contributions in three broad categories:
## Where to start
- Docs landing page: [`docs/README.md`](./docs/README.md)
- Development workflow: [`docs/03-development.md`](./docs/03-development.md)
- Testing guide: [`docs/testing/README.md`](./docs/testing/README.md)
- Docs landing page: [Docs landing](./docs/README.md)
- Development workflow: [Development workflow](./docs/03-development.md)
- Testing guide: [Testing guide](./docs/testing/README.md)
## Filing issues

18
README.md
View File

@@ -18,17 +18,17 @@ Mission Control is a small, service-oriented stack:
- **Frontend:** Next.js (default http://localhost:3000)
- **Backend:** FastAPI (default http://localhost:8000)
- **Database:** Postgres
- **Gateway integration (optional):** WebSocket protocol documented in [`docs/openclaw_gateway_ws.md`](./docs/openclaw_gateway_ws.md)
- **Gateway integration (optional):** WebSocket protocol documented in [Gateway WebSocket protocol](./docs/openclaw_gateway_ws.md)
## Documentation
Start with the docs landing page:
- [`docs/README.md`](./docs/README.md)
- [Docs landing](./docs/README.md)
Operational deep dives:
- Deployment: [`docs/deployment/README.md`](./docs/deployment/README.md)
- Production notes: [`docs/production/README.md`](./docs/production/README.md)
- Troubleshooting: [`docs/troubleshooting/README.md`](./docs/troubleshooting/README.md)
- Deployment: [Deployment guide](./docs/deployment/README.md)
- Production notes: [Production notes](./docs/production/README.md)
- Troubleshooting: [Troubleshooting](./docs/troubleshooting/README.md)
## Authentication (Clerk)
@@ -38,7 +38,7 @@ You must configure Clerk keys for:
- the frontend (`NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`, `CLERK_SECRET_KEY`)
- the backend (`CLERK_SECRET_KEY`)
See: [`docs/deployment/README.md`](./docs/deployment/README.md#clerk-auth-notes).
See: [Deployment guide](./docs/deployment/README.md#clerk-auth-notes).
## Deployment modes
@@ -86,12 +86,12 @@ docker compose -f compose.yml --env-file .env down -v
This is the fastest workflow for contributors: run Postgres via Docker, and run the backend + frontend in dev mode.
See: [`docs/03-development.md`](./docs/03-development.md)
See: [Development workflow](./docs/03-development.md)
## Testing and CI parity
- Testing guide: [`docs/testing/README.md`](./docs/testing/README.md)
- Coverage policy: [`docs/coverage-policy.md`](./docs/coverage-policy.md)
- Testing guide: [Testing guide](./docs/testing/README.md)
- Coverage policy: [Coverage policy](./docs/coverage-policy.md)
From repo root:

2
docs/02-quickstart.md
View File

@@ -11,4 +11,4 @@ After `docker compose up`:
## Common gotchas
- `NEXT_PUBLIC_API_URL` must be reachable from your browser (host), not just from inside Docker.
- Clerk auth is required; ensure Clerk keys are configured (see `docs/deployment/README.md`).
- Clerk auth is required; ensure Clerk keys are configured (see [Deployment guide](deployment/README.md)).

2
docs/05-architecture.md
View File

@@ -82,7 +82,7 @@ Notes:
Mission Control can coordinate with OpenClaw Gateways over WebSockets.
- Protocol methods/events list: `backend/app/services/openclaw/gateway_rpc.py`.
- Operator-facing protocol docs: `docs/openclaw_gateway_ws.md`.
- Operator-facing protocol docs: [Gateway WebSocket protocol](openclaw_gateway_ws.md).
## Where to start reading code

4
docs/10-troubleshooting.md
View File

@@ -14,11 +14,11 @@ This is the “quick triage” page. For detailed playbooks and diagnostics, use
### Frontend keeps redirecting / Clerk errors
- Verify your Clerk keys are set correctly in the frontend environment.
- See: `docs/deployment/README.md` (Clerk auth notes).
- See: [Deployment guide](deployment/README.md) (Clerk auth notes).
### Backend returns 5xx
- Check DB connectivity (`DATABASE_URL`) and migrations.
- Check backend logs.
## Next
- Promote the most common issues from `docs/troubleshooting/README.md` into this page once we see repeated incidents.
- Promote the most common issues from [Troubleshooting deep dive](troubleshooting/README.md) into this page once we see repeated incidents.

2
docs/11-contributing.md
View File

@@ -12,7 +12,7 @@
## Adding/changing docs
- Canonical docs live in `docs/`.
- Follow the IA in `docs/README.md`.
- Follow the IA in [Docs landing](README.md).
## Testing expectations
- See [docs/testing/README.md](testing/README.md).

16
docs/README.md
View File

@@ -24,11 +24,11 @@ This folder is the canonical documentation set for Mission Control.
## Existing deep-dive docs
Some deeper docs already exist under `docs/**` directories; the IA pages above link to them where appropriate:
- `docs/architecture/README.md`
- `docs/deployment/README.md`
- `docs/production/README.md`
- `docs/testing/README.md`
- `docs/troubleshooting/README.md`
- `docs/openclaw_gateway_ws.md`
- `docs/openclaw_gateway_base_config.md`
These deeper references already exist under `docs/` directories:
- [Architecture deep dive](architecture/README.md)
- [Deployment guide](deployment/README.md)
- [Production notes](production/README.md)
- [Testing guide](testing/README.md)
- [Troubleshooting](troubleshooting/README.md)
- [Gateway WebSocket protocol](openclaw_gateway_ws.md)
- [Gateway base config](openclaw_gateway_base_config.md)

10
docs/architecture/README.md
View File

@@ -54,8 +54,8 @@ flowchart LR
### Gateway integration (optional)
Mission Control can call into an OpenClaw Gateway over WebSockets.
- Client + protocol: `backend/app/services/openclaw/gateway_rpc.py`
- Protocol doc: `docs/openclaw_gateway_ws.md`
- Base gateway config (getting started): `docs/openclaw_gateway_base_config.md`
- Protocol doc: [Gateway WebSocket protocol](../openclaw_gateway_ws.md)
- Base gateway config (getting started): [Gateway base config](../openclaw_gateway_base_config.md)
## Request flows
@@ -110,9 +110,9 @@ Frontend:
## Related docs
- Self-host (Docker Compose): see repo root README: [Quick start (self-host with Docker Compose)](../../README.md#quick-start-self-host-with-docker-compose)
- Production-ish deployment: [`docs/production/README.md`](../production/README.md)
- Testing (Cypress/Clerk): [`docs/testing/README.md`](../testing/README.md)
- Troubleshooting: [`docs/troubleshooting/README.md`](../troubleshooting/README.md)
- Production-ish deployment: [Production notes](../production/README.md)
- Testing (Cypress/Clerk): [Testing guide](../testing/README.md)
- Troubleshooting: [Troubleshooting](../troubleshooting/README.md)
## Notes / gotchas
- Mermaid rendering depends on the markdown renderer.

4
docs/openclaw_gateway_base_config.md
View File

@@ -3,8 +3,8 @@
This document explains a "base" OpenClaw Gateway config intended for local development and LAN use, and how to connect it to Mission Control.
Related:
- Gateway WebSocket protocol: `docs/openclaw_gateway_ws.md` (default URL `ws://127.0.0.1:18789`)
- Mission Control architecture (gateway integration): `docs/architecture/README.md`
- Gateway WebSocket protocol: [Gateway WebSocket protocol](openclaw_gateway_ws.md) (default URL `ws://127.0.0.1:18789`)
- Mission Control architecture (gateway integration): [Architecture deep dive](architecture/README.md)
## Who This Is For

2
docs/testing/README.md
View File

@@ -30,7 +30,7 @@ Implementation in this repo:
- `cy.clerkLoaded()`
- `cy.clerkSignIn(...)` / `cy.clerkSignOut(...)`
See also: [`docs/e2e-auth.md`](../e2e-auth.md).
See also: [E2E auth notes](../e2e-auth.md).
### Test user (non-secret)