Skip to content

Wire the docs → cockpit handoff for deep-agents and runtimes - #938

Merged
blove merged 1 commit into
mainfrom
blove/deep-agents-reverse-links
Sep 1, 2026
Merged

Wire the docs → cockpit handoff for deep-agents and runtimes#938
blove merged 1 commit into
mainfrom
blove/deep-agents-reverse-links

Conversation

@blove

@blove blove commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #937 (deep-agents docs) and #913 (runtimes docs).

The cockpit → docs direction was already wired for both libraries: COCKPIT_DOCS_LINKS covers all six deep-agents entries and all four runtimes entries, so every one of those demos has a working "Read docs" button. The reverse table, docsCockpitMappings, still only knew the five first-iteration pages — so every deep-agents and runtimes docs page sent its Run/Code/API buttons to Cockpit home instead of the demo the page describes.

Runtimes lacked reverse links too, so they are fixed here in the same PR.

The 16 new entries

Docs page Cockpit target
deep-agents/getting-started/introduction deep-agents/getting-started/overview
deep-agents/capabilities/{planning,filesystem,subagents,memory,skills} deep-agents/core-capabilities/<topic>
runtimes/getting-started/introduction runtimes/getting-started/overview
runtimes/{aws-strands,microsoft-agent-framework,mastra}/{overview,quickstart,how-it-connects} runtimes/core-capabilities/<runtime>

Two judgment calls worth a look:

  • All three pages of a runtime section share one target. A runtime is documented across overview / quickstart / how-it-connects, and its single demo serves a reader on any of them. Mapping only overview would leave two-thirds of the runtimes library on the Cockpit-home fallback.
  • The introduction pages map to their product's getting-started/overview. Those manifest entries are entryKind: 'docs-only', so Run mode lands on the product's Cockpit overview rather than a live demo — still a better destination than Cockpit home, and it keeps the Capability row truthful. This is the exact inverse of what COCKPIT_DOCS_LINKS already does.

Analytics

AnalyticsLibrary did not include deep-agents or runtimes, so every handoff from these two libraries would have been logged as library: 'unknown' — the new links would have been invisible in the funnel they exist to feed. Both are added to the type and to toAnalyticsLibrary.

Verification

Production URLs — all ten destinations return a hard 200. The check discriminates rather than rubber-stamping: an unknown topic 307s to the fallback, an unknown product 500s, and an unknown language 307s, so these are real pages and not SPA soft-200s.

Render check (website dev server, accessibility tree):

  • /docs/deep-agents/capabilities/planning…/deep-agents/core-capabilities/planning/overview/python?mode=run|code|api
  • /docs/runtimes/mastra/quickstart…/runtimes/core-capabilities/mastra/overview/python?mode=run
  • /docs/deep-agents/getting-started/introduction…/deep-agents/getting-started/overview/overview/python?mode=run
  • /docs/chat/guides/theming (still unmapped, negative control) → …/?mode=run

The negative control is what proves the mapping is driving the difference. The rendered result is identical in shape to an already-mapped page (/docs/langgraph/guides/streaming). No console errors.

Tests — the exact pin is updated, plus four new guards:

  1. every mapping key names a page that exists in docs-config (a typo'd key is otherwise invisible — the page silently keeps the Cockpit-home fallback);
  2. the deep-agents and runtimes links round-trip against COCKPIT_DOCS_LINKS, so the two tables in two packages cannot drift apart;
  3. handoffs report deep-agents / runtimes rather than unknown;
  4. each runtime section's three pages resolve to the same demo.

All four were mutation-tested — a typo'd key, a wrong topic, a dropped allowlist case, and a deleted entry each fail the suite.

nx test website: 59 files, 452 tests passing. nx lint website: 0 errors (27 pre-existing warnings). No lockfile changes.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Sep 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
threadplane Ready Ready Preview Sep 1, 2026 10:50pm UTC

Request Review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated approval: this PR received an intelligent (AI) code review. See the review comments on this PR.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

@blove
blove force-pushed the blove/deep-agents-reverse-links branch from fc6056b to 8e9441b Compare September 1, 2026 22:38
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

…untimes

The cockpit -> docs direction shipped with both libraries (COCKPIT_DOCS_LINKS
covers all six deep-agents entries and all four runtimes entries), but the
reverse table only knew the five first-iteration pages. Every deep-agents page
(#937) and every runtimes page (#913) sent its Run/Code/API buttons to Cockpit
home instead of the demo the page describes.

Add the 16 missing entries:

- deep-agents: the five capability pages map to their core-capabilities topic;
  the introduction maps to deep-agents/getting-started/overview.
- runtimes: all three pages of each runtime section (overview, quickstart,
  how-it-connects) map to that runtime's one demo, since a single demo serves
  them equally well; the introduction maps to runtimes/getting-started/overview.

Also add deep-agents and runtimes to AnalyticsLibrary. Without it every handoff
from these two libraries would have been attributed to 'unknown', so the new
links would be invisible in the funnel they exist to feed.

Each of the ten destination URLs was checked against production and returns a
hard 200. The check discriminates: an unknown topic 307s to the fallback and an
unknown product 500s, so the 200s are real pages rather than SPA soft-200s.

Tests: the exact pin is updated, plus four guards — every key names a page that
exists in docs-config (a typo'd key is otherwise invisible: the page just keeps
the Cockpit-home fallback), the deep-agents/runtimes links round-trip against
COCKPIT_DOCS_LINKS, the analytics library is no longer 'unknown', and each
runtime section's three pages resolve to the same demo. All four were
mutation-tested to confirm they fail when the mapping is wrong.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@blove
blove force-pushed the blove/deep-agents-reverse-links branch from 8e9441b to 91488ee Compare September 1, 2026 22:43
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

@blove
blove merged commit 407c995 into main Sep 1, 2026
27 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant