Repository navigation
docs: add site-wide sidebar, homepage GitHub link, and fix mobile table overflow - #265
Merged
Merged
Conversation
Wrap props tables in a horizontally scrollable container and allow long type names in API item headings to wrap, so the Components, Utilities and Types pages no longer render zoomed out on narrow screens. Closes #262 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HFdmEE6GBwx33cNXgjcv7d
Documentation pages now show a sticky sidebar listing all pages grouped by section, with the current page highlighted. On narrow screens the same navigation (including a GitHub link) is available from the hamburger menu. Closes #261 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HFdmEE6GBwx33cNXgjcv7d
Closes #260 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HFdmEE6GBwx33cNXgjcv7d
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HFdmEE6GBwx33cNXgjcv7d
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
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.
Improves navigation and mobile layout of the docs site. One commit per issue.
Changes
Fix wide tables zooming out the page on mobile (#262)
.table-scrollcontainer, so they scroll horizontally on their own instead of widening the page.RouteComponentPropsWithData<TParams, TData, TState>on the Types page) can now wrap. This was another overflow source on narrow screens.Measured at a 390px mobile viewport: before,
/api/componentslaid out at 587px,/api/utilitiesat 489px and/api/typesat 409px. After, every docs page lays out at 390px.Site-wide documentation sidebar (#261)
DocsLayout(sidebar + content). InApp.tsx, all doc pages except Home and 404 are wrapped in a pathless route that uses it. Most of theApp.tsxdiff is re-indentation.position: sticky) and lists all pages grouped into Getting Started, Learn, API Reference and Resources. The current page is highlighted and marked witharia-current="page". On first load, the sidebar scrolls so the active link is in view.navigation.ts. The sidebar, the mobile menu and the existing Learn/API in-page navs all read from it.GitHub link (#260)
Verification
pnpm --filter funstack-router-docs typecheck,pnpm lintandpnpm format:checkpass, and the docs site builds (Node 24).Closes #260
Closes #261
Closes #262
🤖 Generated with Claude Code
https://claude.ai/code/session_01HFdmEE6GBwx33cNXgjcv7d
Generated by Claude Code