Documentation Section
| Page |
# of broken headings inside tabs |
user-guide/observability-evaluation/logs.mdx |
6 |
user-guide/observability-evaluation/metrics.mdx |
2 |
user-guide/concepts/multi-agent/graph.mdx |
6 |
user-guide/concepts/multi-agent/multi-agent-patterns.mdx |
3 |
user-guide/concepts/plugins/index.mdx |
2 |
user-guide/concepts/tools/mcp-tools.mdx |
2 |
Current State
Multiple documentation pages have markdown headings (##, ###, ####) inside <Tab> components. These headings get picked up by the right-side table of contents, but clicking them doesn’t navigate anywhere because the content is hidden inside an inactive tab.
This was originally reported for the swarm page in #750, but the same pattern exists across 6 additional pages with 21 more headings.
Suggested Improvement
Current fix
Possible approaches
- Convert to bold text — simple, removes from TOC, slightly reduces visual hierarchy
- Use HTML
<h3> tags — may preserve visual styling while avoiding markdown TOC extraction (needs testing)
- Fix at the framework level — update the TOC component to handle or exclude headings inside tabs
Rationale
TOC shows broken links that lead to nowhere in each SDK
Additional Context
No response
Documentation Section
user-guide/observability-evaluation/logs.mdxuser-guide/observability-evaluation/metrics.mdxuser-guide/concepts/multi-agent/graph.mdxuser-guide/concepts/multi-agent/multi-agent-patterns.mdxuser-guide/concepts/plugins/index.mdxuser-guide/concepts/tools/mcp-tools.mdxCurrent State
Multiple documentation pages have markdown headings (
##,###,####) inside<Tab>components. These headings get picked up by the right-side table of contents, but clicking them doesn’t navigate anywhere because the content is hidden inside an inactive tab.This was originally reported for the swarm page in #750, but the same pattern exists across 6 additional pages with 21 more headings.
Suggested Improvement
Current fix
###headings to bold text (**...**), which removes them from the TOC. This works but loses the visual heading hierarchy.Possible approaches
<h3>tags — may preserve visual styling while avoiding markdown TOC extraction (needs testing)Rationale
TOC shows broken links that lead to nowhere in each SDK
Additional Context
No response