Skip to content

Commit da871ad

Browse files
committed
chore(showcase/dashboard): make docs-og and docs-shell green across the matrix
Replaces dead `https://docs.copilotkit.ai/features/<id>` URLs in the shared feature registry with paths that actually resolve, so the dashboard's docs-og / docs-shell badges stop falling back to red ✗ for every cell that has no per-package override. What changed - `showcase/shared/feature-registry.json`: - rename legacy `shell_docs_url` → canonical `shell_docs_path` (silences the probe's legacy-key warning) - point `og_docs_url` at indexable docs.copilotkit.ai pages and `shell_docs_path` at existing `.mdx` files in `showcase/shell-docs/src/content/docs/` - leave fields unset for features with no real docs page yet (`auth`, `agent-config`, `voice`, `multimodal`, `byoc-hashbrown`, `byoc-json-render`, plus the `kind: testing` features whose docs row is hidden by `CellStatus`) - `showcase/packages/<framework>/docs-links.json`: fill in `null` entries with the closest framework-specific page that exists, or fall back to a framework-agnostic root (`/multi-agent`, `/shared-state`, etc.) where no scoped page exists. Files touched: ag2, agno, claude-sdk-python, claude-sdk-typescript, crewai-crews, google-adk, langgraph-python, llamaindex, mastra, ms-agent-dotnet, ms-agent-python, pydantic-ai, spring-ai, strands. - New: `showcase/packages/langroid/docs-links.json` (was missing entirely; modeled on the spring-ai/strands pattern since no langroid-scoped pages exist on docs.copilotkit.ai). Coverage - Probe (`pnpm -C showcase/scripts probe-docs`) goes from every-feature-`notfound` to `ok=61 / notfound=1 / missing=18` across 40 features × 2 links. - Dashboard cell simulation: 687 docs cells green, 145 red. Remaining reds are exclusively features with no real docs target yet (auth/voice/multimodal/agent-config/byoc-* on integrations whose framework docs don't have those pages). No code changes — only the JSON sources of truth. The generated artifacts (`shell-dashboard/src/data/{registry,docs-status,catalog}.json`, `shell-{docs,dojo}/src/data/...`) are gitignored and rebuilt by `pnpm -C showcase/scripts {generate-registry,probe-docs}` on dev/CI.
1 parent 64ac609 commit da871ad

16 files changed

Lines changed: 185 additions & 149 deletions

File tree

showcase/packages/ag2/docs-links.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/ag2/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/ag2/shared-state",
@@ -30,14 +30,14 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
},
3737
"missing": [
3838
{
3939
"feature": "subagents",
40-
"reason": "No /ag2/multi-agent/subagents page on docs.copilotkit.ai (returns SPA fallback)."
40+
"reason": "No /ag2/multi-agent/subagents page on docs.copilotkit.ai (SPA fallback). OG falls back to the framework-agnostic /multi-agent overview; shell points at the unified /multi-agent/subagents content."
4141
}
4242
]
4343
}

showcase/packages/agno/docs-links.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
@@ -30,8 +30,8 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
}
3737
}

showcase/packages/claude-sdk-python/docs-links.json

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
@@ -30,8 +30,8 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
},
3737
"missing": [
@@ -43,17 +43,13 @@
4343
"feature": "hitl-in-chat",
4444
"reason": "No framework-scoped docs. Root /human-in-the-loop exists and is used for og. Shell /unselected/human-in-the-loop.mdx is missing — using /generative-ui/your-components/interactive which is the closest match (interactive components HITL in chat)."
4545
},
46-
{
47-
"feature": "gen-ui-agent",
48-
"reason": "Root /generative-ui/state-rendering exists (og), but shell /unselected/generative-ui/state-rendering.mdx does not exist. No suitable shell fallback in /unselected; shell_docs_path is null."
49-
},
5046
{
5147
"feature": "shared-state-streaming",
5248
"reason": "No dedicated streaming doc; root /shared-state/streaming and /shared-state/predictive-state-updates both 404 (og and shell). Falling back to parent /shared-state for both og and shell."
5349
},
5450
{
5551
"feature": "subagents",
56-
"reason": "No claude-sdk-python-scoped, claude-sdk-scoped, or root-scoped subagents/multi-agent docs exist. Checked: /claude-sdk-python/multi-agent/subagents, /claude-sdk/multi-agent/subagents, /multi-agent/subagents, /subagents, /multi-agent — all 404. Shell /unselected has no subagent content. Both og_docs_url and shell_docs_path are null."
52+
"reason": "No claude-sdk-scoped subagents/multi-agent docs exist. OG falls back to the framework-agnostic /multi-agent overview; shell points at the unified /multi-agent/subagents content."
5753
}
5854
]
5955
}

showcase/packages/claude-sdk-typescript/docs-links.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
@@ -30,8 +30,8 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
},
3737
"missing": [
@@ -41,7 +41,7 @@
4141
},
4242
{
4343
"feature": "subagents",
44-
"reason": "No claude-sdk-scoped or root subagents/multi-agent docs exist."
44+
"reason": "No claude-sdk-scoped subagents/multi-agent docs exist. OG falls back to the framework-agnostic /multi-agent overview; shell points at the unified /multi-agent/subagents content."
4545
}
4646
]
4747
}

showcase/packages/crewai-crews/docs-links.json

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,8 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/crewai-crews/multi-agent-flows",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
36-
},
37-
"missing": [
38-
{
39-
"feature": "subagents",
40-
"reason": "No /crewai-crews/multi-agent-flows page on docs.copilotkit.ai (returns SPA fallback). Previous port used /crewai-flows/multi-agent-flows which is a different product."
41-
}
42-
]
36+
}
4337
}

showcase/packages/google-adk/docs-links.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,41 @@
33
"features": {
44
"agentic-chat": {
55
"og_docs_url": "https://docs.copilotkit.ai/adk",
6-
"shell_docs_path": null
6+
"shell_docs_path": "/prebuilt-components"
77
},
88
"hitl-in-chat": {
99
"og_docs_url": "https://docs.copilotkit.ai/adk/human-in-the-loop",
10-
"shell_docs_path": null
10+
"shell_docs_path": "/generative-ui/your-components/interactive"
1111
},
1212
"tool-rendering": {
1313
"og_docs_url": "https://docs.copilotkit.ai/adk/generative-ui/tool-rendering",
14-
"shell_docs_path": null
14+
"shell_docs_path": "/generative-ui/tool-rendering"
1515
},
1616
"gen-ui-tool-based": {
1717
"og_docs_url": "https://docs.copilotkit.ai/adk/generative-ui/your-components/display-only",
18-
"shell_docs_path": null
18+
"shell_docs_path": "/generative-ui/your-components/display-only"
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/adk/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/adk/shared-state/in-app-agent-write",
26-
"shell_docs_path": null
26+
"shell_docs_path": "/shared-state"
2727
},
2828
"shared-state-streaming": {
2929
"og_docs_url": "https://docs.copilotkit.ai/adk/shared-state/predictive-state-updates",
30-
"shell_docs_path": null
30+
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
34-
"shell_docs_path": null
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
},
3737
"missing": [
3838
{
39-
"feature": "all",
40-
"reason": "4085 shell does not have a google-adk-scoped docs tree. Shell paths set to null rather than linking to framework-agnostic pages that would be misleading under the google-adk URL. OG URLs point at the real /adk/... pages on docs.copilotkit.ai."
39+
"feature": "subagents",
40+
"reason": "No /adk/multi-agent or /adk/subagents page on docs.copilotkit.ai (SPA fallback). OG falls back to the framework-agnostic /multi-agent overview; shell points at the unified /multi-agent/subagents content."
4141
}
4242
]
4343
}

showcase/packages/langgraph-python/docs-links.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"shell_docs_path": "/custom-look-and-feel/slots"
2727
},
2828
"chat-customization-css": {
29-
"og_docs_url": null,
29+
"og_docs_url": "https://docs.copilotkit.ai/langgraph/custom-look-and-feel",
3030
"shell_docs_path": "/custom-look-and-feel/css"
3131
},
3232
"headless-simple": {
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"framework": "langroid",
3+
"features": {
4+
"agentic-chat": {
5+
"og_docs_url": "https://docs.copilotkit.ai/agentic-chat-ui",
6+
"shell_docs_path": "/prebuilt-components"
7+
},
8+
"hitl-in-chat": {
9+
"og_docs_url": "https://docs.copilotkit.ai/human-in-the-loop",
10+
"shell_docs_path": "/generative-ui/your-components/interactive"
11+
},
12+
"tool-rendering": {
13+
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/tool-rendering",
14+
"shell_docs_path": "/generative-ui/tool-rendering"
15+
},
16+
"gen-ui-tool-based": {
17+
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/your-components/display-only",
18+
"shell_docs_path": "/generative-ui/your-components/display-only"
19+
},
20+
"gen-ui-agent": {
21+
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/state-rendering",
22+
"shell_docs_path": "/generative-ui/state-rendering"
23+
},
24+
"shared-state-read-write": {
25+
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
26+
"shell_docs_path": "/shared-state"
27+
},
28+
"shared-state-streaming": {
29+
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
30+
"shell_docs_path": "/shared-state"
31+
},
32+
"subagents": {
33+
"og_docs_url": "https://docs.copilotkit.ai/multi-agent",
34+
"shell_docs_path": "/multi-agent/subagents"
35+
}
36+
},
37+
"missing": [
38+
{
39+
"feature": "all",
40+
"reason": "No langroid-scoped docs tree exists on docs.copilotkit.ai (returns SPA fallback). All OG URLs fall back to framework-agnostic top-level pages; shell paths point at the unified content tree which renders under /langroid/unselected/..."
41+
}
42+
]
43+
}

showcase/packages/llamaindex/docs-links.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"shell_docs_path": "/shared-state"
3131
},
3232
"subagents": {
33-
"og_docs_url": null,
33+
"og_docs_url": "https://docs.copilotkit.ai/llamaindex/multi-agent-flows",
3434
"shell_docs_path": "/multi-agent/subagents"
3535
}
3636
}

showcase/packages/mastra/docs-links.json

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
"features": {
44
"agentic-chat": {
55
"og_docs_url": "https://docs.copilotkit.ai/mastra",
6-
"shell_docs_path": null
6+
"shell_docs_path": "/prebuilt-components"
77
},
88
"hitl-in-chat": {
99
"og_docs_url": "https://docs.copilotkit.ai/mastra/human-in-the-loop/tool-based",
10-
"shell_docs_path": null
10+
"shell_docs_path": "/generative-ui/your-components/interactive"
1111
},
1212
"tool-rendering": {
1313
"og_docs_url": "https://docs.copilotkit.ai/mastra/generative-ui/tool-rendering",
@@ -19,7 +19,7 @@
1919
},
2020
"gen-ui-agent": {
2121
"og_docs_url": "https://docs.copilotkit.ai/mastra/generative-ui/state-rendering",
22-
"shell_docs_path": null
22+
"shell_docs_path": "/generative-ui/state-rendering"
2323
},
2424
"shared-state-read-write": {
2525
"og_docs_url": "https://docs.copilotkit.ai/mastra/shared-state",
@@ -31,13 +31,7 @@
3131
},
3232
"subagents": {
3333
"og_docs_url": "https://docs.copilotkit.ai/mastra",
34-
"shell_docs_path": null
34+
"shell_docs_path": "/multi-agent/subagents"
3535
}
36-
},
37-
"missing": [
38-
{
39-
"feature": "all",
40-
"reason": "Previous port used wrong `shell_docs_url` field with absolute http://localhost:3000 URLs (old dev port, also not the correct field — the shell expects `shell_docs_path` relative to the framework root). Normalized to `shell_docs_path` format."
41-
}
42-
]
36+
}
4337
}

0 commit comments

Comments
 (0)