Skip to content

docs(components): Update Menu documentation#3146

Open
taylorvnoj wants to merge 4 commits into
masterfrom
JOB-164255/Menu-eng-docs
Open

docs(components): Update Menu documentation#3146
taylorvnoj wants to merge 4 commits into
masterfrom
JOB-164255/Menu-eng-docs

Conversation

@taylorvnoj
Copy link
Copy Markdown
Contributor

@taylorvnoj taylorvnoj commented May 11, 2026

Why Is This Changing?

Menu docs were out of sync with the current composable API. The docs page still surfaced deprecated items API examples in some places.
We also want Menu to follow the newer colocated packages/components/src/<Component>/docs example pattern already used by other components.

What Is Changing?

Updated Menu documentation to center the composable API and clarify current guidance around Menu.Trigger, Menu.Content, grouping, deprecated wrappers, and legacy items usage.

Moved Menu example components into packages/components/src/Menu/docs/, updated Menu stories to render those extracted examples, and wired the docs page to explicit Canvas code={...} examples.

Also updated the site-level quick example in packages/site/src/content/Menu/index.tsx so it uses the composable API instead of the deprecated items API.

Consumer Impact

  • Impact: None
  • Action required: None
  • Breaking change: No

Validation

Make sure the Docs page renders actual code examples:

Before

Screenshot 2026-05-11 at 9 35 38 PM

After

NOTE: I know it's referencing ForwardRef in a few places. It's a Storybook source-generation issue. There is currently not a fix (that I'm aware of) that won't impact runtime behaviour. This ForwardRef issue also impacts the props page (not displaying Menu.Item in the list of subcomponents) and will also be an issue for components like Autocomplete, Tabs, etc. There is planned follow up here in general for our documentation.

Screenshot 2026-05-11 at 9 35 10 PM

Docs site Canvas uses composable Menu:

Screenshot 2026-05-11 at 9 36 44 PM

Implement tab has up to date documentation for composable Menu:

Screenshot 2026-05-11 at 9 37 21 PM

Reviewer Notes

Changes can be
tested via Pre-release


In Atlantis we use Github's built in pull request reviews.

@taylorvnoj taylorvnoj self-assigned this May 11, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 12, 2026

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: 44a0e5e
Status: ✅  Deploy successful!
Preview URL: https://9931e0ed.atlantis.pages.dev
Branch Preview URL: https://job-164255-menu-eng-docs.atlantis.pages.dev

View logs

@taylorvnoj taylorvnoj requested review from Beccaneer and scotttjob May 12, 2026 11:21
@taylorvnoj taylorvnoj marked this pull request as ready for review May 12, 2026 11:21
@taylorvnoj taylorvnoj requested a review from a team as a code owner May 12, 2026 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant