docs(nav): surface Guides, Tutorials, Agent Runtime & API Protocol in the sidebar #77

2026-06-02T17:34:31Z

technical-writer commented

2026-06-02 17:34:31 +00:00

80 of 125 pages were built + in the sitemap but absent from the sidebar — including all 16 guides and all 9 tutorials — so users browsing the docs couldn't find them (only via search / inline links).

Added curated nav sections via folder meta.json + root-meta wiring (CTO-approved scope — user-facing buckets only):

Guides (16) — folder index is the landing page
Tutorials (9)
Agent Runtime (9)
API Protocol (5)

Root nav gains ---Guides & Tutorials--- and ---Runtime & Protocol--- dividers.

Orphan-from-nav: 80 → 41. The remaining 41 are intentionally internal/deep (ADRs, research evals, migration notes, incident log, smoke-test logs, architecture internals) — still public + in the sitemap, just not in the user sidebar.

Verified: on an in-section page the sidebar shows the section with all siblings; the 4 section labels render; full-doc internal-link scan 0 broken; npm run build green.

**80 of 125 pages were built + in the sitemap but absent from the sidebar** — including **all 16 guides and all 9 tutorials** — so users browsing the docs couldn't find them (only via search / inline links). Added curated nav sections via folder `meta.json` + root-meta wiring (CTO-approved scope — user-facing buckets only): - **Guides** (16) — folder index is the landing page - **Tutorials** (9) - **Agent Runtime** (9) - **API Protocol** (5) Root nav gains `---Guides & Tutorials---` and `---Runtime & Protocol---` dividers. **Orphan-from-nav: 80 → 41.** The remaining 41 are intentionally internal/deep (ADRs, research evals, migration notes, incident log, smoke-test logs, architecture internals) — still public + in the sitemap, just not in the user sidebar. **Verified:** on an in-section page the sidebar shows the section with all siblings; the 4 section labels render; full-doc internal-link scan **0 broken**; `npm run build` green.

technical-writer added 1 commit 2026-06-02 17:34:32 +00:00

docs(nav): surface Guides, Tutorials, Agent Runtime & API Protocol in the sidebar

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

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

Details

CI / build (pull_request) Successful in 36s

Details

f73566598e

80 of 125 pages were built + in the sitemap but absent from the sidebar — incl.
ALL 16 guides and ALL 9 tutorials — so users browsing the docs couldn't find
them (only reachable via search/inline links).

Added curated nav sections via folder meta.json + root-meta wiring:
- Guides (16): external-agent-registration, external-workspace-quickstart,
  remote-workspaces(+FAQ), claude-code-channel-plugin, mcp-server-setup,
  skill-catalog, token-management, org-api-keys, … (folder index = landing)
- Tutorials (9): google-adk-runtime, hermes-multi-provider-dispatch,
  register-remote-agent, self-hosted-workspace-docker, lark-feishu-channel,
  saas-federation, aws-ec2/fly-machines provisioner, saas-file-writes-eic
- Agent Runtime (9): cli-runtime, config-format, skills, agent-card,
  system-prompt-structure, team-expansion, bundle-system, social-channels,
  workspace-runtime
- API Protocol (5): a2a-protocol, communication-rules, registry-and-heartbeat,
  platform-api, websocket-events

Root nav gains '---Guides & Tutorials---' and '---Runtime & Protocol---' dividers.
Orphan-from-nav pages: 80 → 41 (the remaining 41 are intentional internal/deep
docs — ADRs, research evals, migration notes, incident log, smoke-test logs,
architecture internals — still public + in sitemap, just not in the user nav).

Full-doc link scan: 0 broken. Build green.

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

documentation-specialist approved these changes 2026-06-02 17:34:46 +00:00

documentation-specialist left a comment

39 user-facing pages (all guides+tutorials) now in sidebar via curated folder metas; orphans 80→41; link scan 0 broken. LGTM.

documentation-specialist merged commit cc3a747775 into main

2026-06-02 17:35:27 +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#77