Repository navigation
docs(demo): rewrite the Nav page around choosing a pattern - #211
Merged
Merged
Conversation
matthewmr-eqty
requested review from
Shrinks99 and
tmccoy14
and removed request for
Shrinks99
October 30, 2026 20:18
matthewmr-eqty
marked this pull request as draft
October 30, 2026 20:41
matthewmr-eqty
marked this pull request as ready for review
October 30, 2026 20:53
matthewmr-eqty
force-pushed
the
docs/grd-193-nav-page
branch
from
October 30, 2026 20:54
71ef7b4 to
64d3480
Compare
Shrinks99
requested changes
Oct 30, 2026
| | --------------------------------------------------------------------- | ---------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------- | | ||
| | Go to a page | [A row in a group](#groups) | Dashboard, Indicators | Actions, such as Log out: use a [Dropdown Menu](/components/dropdown-menu) | | ||
| | Change to another one of the thing you're in | [`NavSwitcher`](#switcher) | Another project | Filtering a page: use a [Select](/components/select) | | ||
| | Go into something with its own pages, where other rows stop mattering | [Drill in](#drill-in) | A policy, an agent's run, an app's Settings pages | A few views of one screen: use [Tabs](/components/tabs) | |
Member
There was a problem hiding this comment.
Suggested change
| | Go into something with its own pages, where other rows stop mattering | [Drill in](#drill-in) | A policy, an agent's run, an app's Settings pages | A few views of one screen: use [Tabs](/components/tabs) | | |
| | Navigate into a sub-section with its own pages, where other rows in the current section stop mattering | [Drill in](#drill-in) | A policy, an agent's run, an app's Settings pages | A few views of one screen: use [Tabs](/components/tabs) | |
Contributor
Author
There was a problem hiding this comment.
Taken as suggested.
|
|
||
| ## Best Practices | ||
|
|
||
| ### Pages, Not Actions |
Member
There was a problem hiding this comment.
Suggested change
| ### Pages, Not Actions | |
| ### Use Nav for Pages, Not Actions |
tmccoy14
reviewed
Nov 2, 2026
tmccoy14
left a comment
tmccoy14
left a comment
Contributor
There was a problem hiding this comment.
Reads much better organised around picking a pattern. Two small things.
matthewmr-eqty
force-pushed
the
docs/grd-193-nav-page
branch
from
November 2, 2026 16:49
64d3480 to
03c762e
Compare
tmccoy14
approved these changes
Nov 2, 2026
matthewmr-eqty
force-pushed
the
docs/grd-193-nav-page
branch
from
November 2, 2026 17:00
03c762e to
9f17175
Compare
matthewmr-eqty
force-pushed
the
docs/grd-193-nav-page
branch
from
November 2, 2026 17:10
9f17175 to
756ec28
Compare
Shrinks99
approved these changes
Nov 2, 2026
Need: People and agents building a sidebar need to know when a row drills, expands or switches, and the rules to follow. Problem: The page stated the drill rule six times and never said when to expand instead. Solution: It opens with a "Which One to Use" table, shows full app, docs and phone sidebars, and ends with Best Practices, one heading per rule. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Need: Screen reader users jump between landmarks by name. Problem: The Nav page showed three panels called "Project: Ben Project" and two rails called "Main". Solution: The second app sidebar and the Switcher demo name themselves as examples. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Need: People and agents reading the Nav page need each rule to say one thing, and a live example of every documented state. Problem: Review read the switcher sentence as being about the ‹ row, the table's switcher row could describe Tabs, the page told apps to restyle every row, and Retry had no demo. Solution: Switching keeps the reader on the same page and leaves a policy, as Vercel does; the table speaks of sections; the restyle advice is gone; the Retry demo is back in a fixed-height frame. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Need: People building a drill-in sidebar need folders that stay open or closed when the reader drills away and comes back. Problem: 5.2.0 adds `value` to `NavListExpandable` for this, and the Nav page didn't mention it. Solution: A Folders in a Drill-in section and a props row say when to set `value` and that it must be unique within its level. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Need: People server-rendering a sidebar need to know what readers see before or without scripts. Problem: Since 42ccb2f, closed folders show open with JavaScript off, and the page only covered the moment before scripts load. Solution: The server-rendered rule now says every folder shows open with JavaScript off. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
matthewmr-eqty
force-pushed
the
docs/grd-193-nav-page
branch
from
November 2, 2026 18:58
756ec28 to
079edca
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
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.
Review focus
Stacked on #210: review only the last commit,
docs(demo). No release; merging redeploys the docs site.Need
People and agents building a sidebar need to know when a row drills, expands or switches, and the rules to follow.
Problem
The Nav page stated the drill rule six times and never said when to expand. It had no folders, new-tab links or phone layout, and its rules mixed demo pairs with loose bullets.
Change
Rules beside each section were rejected: rules that span parts had no home.
Evidence
astro check, lint and Prettier pass.Not covered
Two runs per eval. The latest runners used Sonnet; the earlier runners' model is unknown. Gaps the eval still found: one example mixing router rows, an external row and a badged folder; a rule for a few flat pages; one page per item, such as a members list.
Part of GRD-193 · GRD-81
🤖 Generated with Claude Code