Skip to content

refactor(storybook): restructure the sidebar, without touching any page - #4706

Open
joana-nunes wants to merge 1 commit into
masterfrom
storybook-nav-structure
Open

joana-nunes wants to merge 1 commit into
masterfrom
storybook-nav-structure

Conversation

@joana-nunes

Copy link
Copy Markdown

Second of the small PRs splitting up the Storybook restructure. This one is navigation structure only.

What changes

  • Sections lose the @ prefix. @components → Components, and the same for @foundation, @content, @patterns and @overview (which reads Get started). The explicit storySort.order already sorts sections, so the @ is no longer doing anything.
  • Components regroup into eight Mantine-aligned groups: Buttons, Combobox, Data display, Feedback, Inputs, Layout, Navigation, Overlays. 42 of the 63 move group.
  • The array / boolean / date / number / string subfolders disappear. Those components now sit directly under Inputs or Combobox, one level shallower.
  • Groups and the components inside them are alphabetical.

What does not change

No page is added, removed or renamed. No page content changes. Every edit in this PR is a title string in a story meta or an MDX <Meta> — 82 files, almost all one line each.

Checked against master's index: 173 entries on both sides, no id added or removed, 168 titles changed, and not one page renamed. Existing URLs keep working, including ?path=/story/... links.

Two things worth your call

Components/Overview now groups differently from the sidebar. That page lists components under Call to action, Forms and inputs, Typography and Miscellaneous — the old names. I left it alone, because changing it would mean changing page content, which this PR deliberately avoids. Worth knowing that the mockup has the same split: it groups the Overview by function (Actions, Navigation, Feedback and status…) and the sidebar by type. So the question isn't really "update the page", it's should the Overview mirror the sidebar at all, or is a by-function view the point of it?

@patterns → Patterns is in here. @johnnyCoveo, this touches the naming of the section you added in #4647. It is the same convention question left open on #4696 — if you'd rather keep the @, say so and I'll drop that part; it's one line.

Reviewing

The diff is 82 nearly identical one-line changes, so reading it file by file won't tell you much. Better: pnpm --filter @coveord/plasma-storybook start and look at the sidebar — that's the whole change.

Navigation structure only. No page is added, removed or renamed, and no page
content changes — every edit is a `title` in a meta or an MDX `<Meta>`.

- sections lose the `@` prefix: `@components` becomes `Components`, and the
  same for `@foundation`, `@content`, `@patterns` and `@overview` (the latter
  reads `Get started`). The explicit `storySort.order` no longer needs the `@`
  to sort sections ahead of the rest.
- components are regrouped into the eight Mantine-aligned groups: Buttons,
  Combobox, Data display, Feedback, Inputs, Layout, Navigation, Overlays.
  42 of the 63 move group; none is added or lost.
- the `array` / `boolean` / `date` / `number` / `string` subfolders under
  Forms and inputs are gone; those components sit directly under Inputs or
  Combobox.
- groups and the components inside them are alphabetical.

Verified against the master index: 173 entries on both sides, no id added or
removed, 168 titles changed and not one page renamed. Existing URLs keep
working.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@svcsnykcoveo

svcsnykcoveo commented Nov 20, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

Copy link
Copy Markdown
Contributor

Release Preview

This PR would not change any package versions if it were merged and released from master.

@github-actions

Copy link
Copy Markdown
Contributor

Live demo of your latest successful build available here:

@joana-nunes
joana-nunes marked this pull request as ready for review November 20, 2026 14:40
@joana-nunes
joana-nunes requested a review from a team as a code owner November 20, 2026 14:40
@joana-nunes
joana-nunes requested review from GermainBergeron, gdostie and johnnyCoveo and a balanced review from Copilot and removed request for a team November 20, 2026 14:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The Storybook sidebar reorganization has no active review issues.

No open issues 🎉

What changed in this PR

Continues the Storybook navigation restructure after #4696, reorganizing Plasma’s documentation sidebar while leaving page content, component behavior, and explicit story/docs IDs unchanged.

Changes:

  • Removes section @ prefixes and introduces the labels “Get started” and “Foundations.”
  • Regroups components into eight categories and removes input-type nesting from sidebar titles.
  • Updates section ordering and enables alphabetical fallback sorting for component entries.
File Description
packages/​storybook/​src/​patterns/​PatternsOverview.mdx Uses the Patterns section.
packages/​storybook/​src/​patterns/​NavigateWithLinks.mdx Uses the Patterns section.
packages/​storybook/​src/​overview/​UsingLLMs.mdx Uses the Get started section.
packages/​storybook/​src/​overview/​GettingStarted.mdx Uses the Get started section.
packages/​storybook/​src/​content/​WritingMechanics.mdx Uses the Content section.
packages/​storybook/​src/​content/​Voice.mdx Uses the Content section.
packages/​storybook/​src/​content/​TargetAudience.mdx Uses the Content section.
packages/​storybook/​src/​content/​ProductVocabulary.mdx Uses the Content section.
packages/​storybook/​src/​content/​Glossary.mdx Uses the Content section.
packages/​storybook/​src/​content/​AboutContent.mdx Uses the Content section.
packages/​storybook/​src/​components/​typography/​Kbd.stories.tsx Places Kbd under Data display.
packages/​storybook/​src/​components/​typography/​EllipsisText.stories.tsx Places EllipsisText under Data display.
packages/​storybook/​src/​components/​miscellaneous/​Menu.stories.tsx Places Menu under Overlays.
packages/​storybook/​src/​components/​layout/​Tabs.stories.tsx Places Tabs under Navigation.
packages/​storybook/​src/​components/​layout/​StickyFooter.stories.tsx Removes the section prefix; retains Layout.
packages/​storybook/​src/​components/​layout/​ScrollArea.stories.tsx Removes the section prefix; retains Layout.
packages/​storybook/​src/​components/​layout/​Prompt.stories.tsx Places Prompt under Overlays.
packages/​storybook/​src/​components/​layout/​Navigation.stories.tsx Places Navigation under Navigation.
packages/​storybook/​src/​components/​layout/​Modal.stories.tsx Places Modal under Overlays.
packages/​storybook/​src/​components/​layout/​Header.stories.tsx Removes the section prefix; retains Layout.
packages/​storybook/​src/​components/​layout/​Drawer.stories.tsx Places Drawer under Overlays.
packages/​storybook/​src/​components/​layout/​ChildForm.stories.tsx Places ChildForm under Inputs.
packages/​storybook/​src/​components/​layout/​BrowserPreview.stories.tsx Places BrowserPreview under Data display.
packages/​storybook/​src/​components/​layout/​AppShell.stories.tsx Removes the section prefix; retains Layout.
packages/​storybook/​src/​components/​layout/​Accordion.stories.tsx Removes the section prefix; retains Layout.
packages/​storybook/​src/​components/​foundation/​variables/​Variables.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​typography/​Typography.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​spacings/​Spacings.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​shadows/​Shadows.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​radii/​Radii.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​iconography/​Iconography.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​foundation/​colors/​Colors.stories.tsx Uses the Foundations section.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​TextInput.stories.tsx Places TextInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​Textarea.stories.tsx Places Textarea directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​Select.stories.tsx Places Select directly under Combobox.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​SegmentedControl.stories.tsx Places SegmentedControl directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​RadioCard.stories.tsx Places RadioCard directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​Radio.stories.tsx Places Radio directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​PasswordInput.stories.tsx Places PasswordInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​Combobox.stories.tsx Places Combobox directly under Combobox.
packages/​storybook/​src/​components/​forms-and-inputs/​string/​CodeEditor.stories.tsx Places CodeEditor directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​number/​SliderInput.stories.tsx Places SliderInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​number/​Slider.stories.tsx Places Slider directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​number/​NumberInput.stories.tsx Places NumberInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​date/​YearPickerInput.stories.tsx Places YearPickerInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​date/​TimePicker.stories.tsx Places TimePicker directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​date/​MonthPickerInput.stories.tsx Places MonthPickerInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​date/​DatePickerInput.stories.tsx Places DatePickerInput directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​boolean/​Switch.stories.tsx Places Switch directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​boolean/​Checkbox.stories.tsx Places Checkbox directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​array/​MultiSelect.stories.tsx Places MultiSelect directly under Combobox.
packages/​storybook/​src/​components/​forms-and-inputs/​array/​Facet.stories.tsx Places Facet directly under Combobox.
packages/​storybook/​src/​components/​forms-and-inputs/​array/​Collection.stories.tsx Places Collection directly under Inputs.
packages/​storybook/​src/​components/​forms-and-inputs/​array/​Chip.stories.tsx Places Chip directly under Inputs.
packages/​storybook/​src/​components/​feedback/​Tooltip.stories.tsx Places Tooltip under Overlays.
packages/​storybook/​src/​components/​feedback/​Stepper.stories.tsx Places Stepper under Navigation.
packages/​storybook/​src/​components/​feedback/​StatusToken.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​Skeleton.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​Progress.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​PrerequisitesList.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​Notification.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​Loader.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​LastUpdated.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​InfoToken.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​ContextualHelp.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​feedback/​Alert.stories.tsx Removes the section prefix; retains Feedback.
packages/​storybook/​src/​components/​data-display/​Table.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​data-display/​Pill.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​data-display/​Image.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​data-display/​Carousel.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​data-display/​Card.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​data-display/​Badge.stories.tsx Removes the section prefix; retains Data display.
packages/​storybook/​src/​components/​ComponentsOverview.mdx Uses Components; leaves overview content unchanged.
packages/​storybook/​src/​components/​call-to-action/​Pagination.stories.tsx Places Pagination under Navigation.
packages/​storybook/​src/​components/​call-to-action/​NavLink.stories.tsx Places NavLink under Navigation.
packages/​storybook/​src/​components/​call-to-action/​CopyToClipboard.stories.tsx Places CopyToClipboard under Buttons.
packages/​storybook/​src/​components/​call-to-action/​CloseButton.stories.tsx Places CloseButton under Buttons.
packages/​storybook/​src/​components/​call-to-action/​Button.stories.tsx Places Button under Buttons.
packages/​storybook/​src/​components/​call-to-action/​Breadcrumbs.stories.tsx Places Breadcrumbs under Navigation.
packages/​storybook/​src/​components/​call-to-action/​Anchor.stories.tsx Places Anchor under Navigation.
packages/​storybook/​src/​components/​call-to-action/​ActionIcon.stories.tsx Places ActionIcon under Buttons.
packages/​storybook/​.storybook/​preview.tsx Updates explicit navigation order and alphabetical fallback.

Review effort: Balanced

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants