feat: docs navigation — breadcrumbs, TOC, prev/next, cross-links, mobile menu - #9
Merged
Conversation
…ile menu 5 new components: - navigation.ts: centralized nav data for docs + use cases - Breadcrumb.svelte: replaces ad-hoc back-links on all inner pages - TableOfContents.svelte: sticky right-rail (desktop) + collapsible (mobile) with IntersectionObserver active tracking - PrevNextNav.svelte: prev/next page cards at bottom of every doc and use case page - RelatedContent.svelte: cross-links docs <-> use cases with type badges Integration page: 9 h2 anchor IDs, TOC, breadcrumb, related use cases, next -> self-hosting Self-hosting page: 7 h2 anchor IDs, TOC, breadcrumb, related integration guide, prev -> integration UseCasePage: breadcrumb, slug prop, related links, prev/next between use cases Docs index: use case cards section at bottom for discovery Use cases index: "Ready to integrate?" callout linking to integration guide Nav: mobile hamburger menu with docs + use cases + GitHub links Footer: dynamic use case links from navigation.ts
YairEtzion
force-pushed
the
feat/docs-navigation
branch
from
April 2, 2026 17:11
bd46408 to
52fab64
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Complete docs navigation overhaul. Fixes 11 identified pain points from the navigation audit.
5 new components:
navigation.ts— centralized nav data (single source of truth for doc pages + use case pages)Breadcrumb.svelte— consistent breadcrumbs on all inner pages (replaces ad-hoc back-links)TableOfContents.svelte— sticky right-rail on desktop (IntersectionObserver active tracking), collapsible on mobilePrevNextNav.svelte— prev/next page cards at bottom of every doc and use case pageRelatedContent.svelte— cross-links docs and use cases with "Doc"/"Use Case" type badgesPage improvements:
Mobile nav:
Footer:
Test plan
bun run build— all pages prerender