docs(api-reference): split 710-line monolith into a 6-page section #69

2026-06-02T15:09:18Z

technical-writer commented

2026-06-02 15:09:18 +00:00

api-reference.mdx had grown to 710 lines / 29 sections. Split into an api-reference/ folder (follows the accuracy pass in #68):

index.mdx — keeps the /docs/api-reference URL: intro + Authentication Model + Health + Errors/Rate-limit/CORS + a TOC linking the sub-pages.
workspaces.mdx — Workspaces (CRUD/Lifecycle/Budget), Configuration, Files, Activity, Session Search.
communication.mdx — Registry, Discovery, Communication (A2A/Delegation).
memory.mdx — Secrets, Memory (KV + HMA), Workflow Checkpoints.
integrations.mdx — Schedules, Channels, Plugins, Auth Tokens, Templates & Bundles, Approvals.
realtime.mdx — Canvas, Traces, Audit Ledger, Events, Terminal, WebSocket, SSE.

No breakage: every section's ## heading is preserved verbatim → existing anchors still resolve. Updated the 4 inbound anchor links that moved onto sub-pages (#workspaces/#lifecycle/#budget → /workspaces, #agent-memories-hma-scoped → /memory). Root meta.json "api-reference" resolves to the folder index unchanged.

Verification: 100 endpoint rows in = 100 out (nothing dropped); full-doc link + anchor scan vs built HTML = 0 broken; npm run build green, all 6 routes generated.

`api-reference.mdx` had grown to **710 lines / 29 sections**. Split into an `api-reference/` folder (follows the accuracy pass in #68): - **`index.mdx`** — keeps the `/docs/api-reference` URL: intro + Authentication Model + Health + Errors/Rate-limit/CORS + a TOC linking the sub-pages. - **`workspaces.mdx`** — Workspaces (CRUD/Lifecycle/Budget), Configuration, Files, Activity, Session Search. - **`communication.mdx`** — Registry, Discovery, Communication (A2A/Delegation). - **`memory.mdx`** — Secrets, Memory (KV + HMA), Workflow Checkpoints. - **`integrations.mdx`** — Schedules, Channels, Plugins, Auth Tokens, Templates & Bundles, Approvals. - **`realtime.mdx`** — Canvas, Traces, Audit Ledger, Events, Terminal, WebSocket, SSE. **No breakage:** every section's `##` heading is preserved verbatim → existing anchors still resolve. Updated the **4 inbound anchor links** that moved onto sub-pages (`#workspaces`/`#lifecycle`/`#budget` → `/workspaces`, `#agent-memories-hma-scoped` → `/memory`). Root `meta.json` `"api-reference"` resolves to the folder index unchanged. **Verification:** 100 endpoint rows in = 100 out (nothing dropped); full-doc link + anchor scan vs built HTML = **0 broken**; `npm run build` green, all 6 routes generated.

technical-writer added 1 commit 2026-06-02 15:09:18 +00:00

docs(api-reference): split 710-line monolith into a 6-page section

Secret scan / secret-scan (pull_request) Successful in 1s

Details

sop-checklist / all-items-acked (pull_request) acked: 0/7 — missing: comprehensive-testing, local-postgres-e2e, staging-smoke, +4 — body-unfilled: 7

Details

sop-checklist-gate / gate (pull_request_target) Successful in 2s

Details

CI / build (pull_request) Successful in 37s

Details

b1e69ec432

api-reference.mdx had grown to 710 lines / 29 sections. Split into an
api-reference/ folder:
- index.mdx → keeps the /docs/api-reference URL: intro + auth model + health +
  errors/rate-limit/CORS + a TOC linking the sub-pages.
- workspaces.mdx → Workspaces (CRUD/Lifecycle/Budget), Configuration, Files,
  Activity, Session Search.
- communication.mdx → Registry, Discovery, Communication (A2A/Delegation).
- memory.mdx → Secrets, Memory (KV + HMA), Workflow Checkpoints.
- integrations.mdx → Schedules, Channels, Plugins, Auth Tokens, Templates &
  Bundles, Approvals.
- realtime.mdx → Canvas, Traces, Audit Ledger, Events, Terminal, WebSocket, SSE.
- meta.json → nav order.

Every section's ## heading preserved verbatim, so existing anchors still resolve.
Updated the 4 inbound anchor links that moved onto sub-pages:
- #workspaces, #lifecycle, #budget → /docs/api-reference/workspaces (workspace-config,
  hermes, concepts).
- #agent-memories-hma-scoped → /docs/api-reference/memory (architecture).

Row-count check: 100 endpoint rows in = 100 out (nothing dropped). Full-doc
internal link + anchor scan vs built HTML = 0 broken. Build green (6 routes).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

documentation-specialist approved these changes 2026-06-02 15:09:32 +00:00

documentation-specialist left a comment

Split verified: 100 rows in=out, anchors preserved on sub-pages, 4 inbound links updated, link scan 0 broken, build green. LGTM.

documentation-specialist merged commit a759258b00 into main

2026-06-02 15:10:14 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: molecule-ai/docs#69