Repository navigation
docs: redesign the docs shell, component pages and first steps - #2346
Merged
Merged
Conversation
46 component pages carried a Preview tag and five a New tag that dated from 1.0. Every documented component is in RELEASED_COMPONENTS and out of the Storybook WIP category except Command, which stays Preview. New now marks what 1.2.0 added: DirectionProvider and Slot.
Shell: the sidebar groups the components by what they are for (eight groups from app/docs/componentGroups.ts, collapsible, with counts), starts with a search field and gets a Command palette over every page on Cmd+K; the top bar shows the pinned version and a search button; phones get a Drawer instead of a full-page list; the table of contents has a rail that fills as you read; the blueprint grid behind articles is gone; every page ends with previous and next cards. Component page: breadcrumb, a copyable import line, Source / Report an issue / Changelog links, a preview stage with appearance and accent controls (a nested Theme around the example) and an Open in playground link, React / Styles tabs, line-numbered code that no longer wraps, part chips under the API heading, API tables without the bordered chips, and one type scale (h2 1.5rem, h3 1.125rem, body 0.95rem) shared with MDX. Pages: /docs/components is a grouped index with a one-line purpose per component; Installation covers install, which setup to pick, the Next.js layout, a first component and troubleshooting; Introduction is shorter.
Sidebar counts and code line numbers were below 4.5:1 in light mode (and the numbers in dark), and three groups predate the redesign: changelog links in blue-900, MDX list items and blockquotes in gray-900. All now use the 950 steps or primary text at 90%.
|
Contributor
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 44 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
The docs snippet checker reads every "@radui/ui/..." string as a subpath to
verify, and the template "@radui/ui/${name}" failed it in CI.
Contributor
CoverageThis report compares the PR with the base branch. "Δ" shows how the PR affects each metric.
Coverage improved or stayed the same. Great job! Run |
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.
Docs only (
docs/). Continues the docs showcase plan: the docs pages get the same quality as the October landing page.Shell
app/docs/componentGroups.ts, collapsible, with counts), a search field on top, New/Preview as small tags.Command.Dialog, Cmd/Ctrl+K), with each component's one-line purpose as keywords so "modal" finds Dialog.@radui/uiversion linking to the changelog, search button.Drawerfrom the left instead of a full-page list.Component page template
Breadcrumb, copyable import line, Source / Report an issue / Changelog links, a preview stage with appearance and accent controls (a nested
Themearound the example, with the light-token fix shared from the landing playground) and an Open in playground link, React/Styles tabs, line-numbered code that no longer wraps, part chips under the API heading, API tables without the bordered chips, one type scale (h2 1.5rem, h3 1.125rem, body 0.95rem) shared with MDX. The 70+ pages pick this up throughDocumentation.jswith no content edits.Pages
/docs/components: grouped index, one card per component with its purpose.Status tags
Every documented component is stable except Command (still WIP in Storybook). New marks what 1.2.0 added: DirectionProvider and Slot.
Checks
pnpm lint,pnpm check:examples,pnpm build(boundary, registry, llms, 306 pages prerendered, static check) and the contrast check (302 routes in both themes) all pass. The contrast fixes include three groups that predate this PR: changelog links in blue-900, MDX list items and blockquotes in gray-900.Checked at 1512, 1024 and 390 px in both themes.