Skip to content

docs(components): rewrite Menu component documentation#3053

Merged
taylorvnoj merged 4 commits into
masterfrom
menu-docs-edit
May 8, 2026
Merged

docs(components): rewrite Menu component documentation#3053
taylorvnoj merged 4 commits into
masterfrom
menu-docs-edit

Conversation

@George-W-M
Copy link
Copy Markdown
Contributor

@George-W-M George-W-M commented Apr 8, 2026

Summary

  • Restructured the Menu docs page to follow the standardized component documentation format (Summary, Anatomy, Behavior, Variants, Content Guidelines, Do's and Don'ts, Accessibility, Related Components)
  • Expanded the Content Guidelines section with Do/Don't tables covering sentence case, verb-first labels, conciseness, avoiding activator context repetition, consistent verb tense, group label formatting, and destructive item labeling
  • Added Accessibility section with keyboard navigation table and touch target specs
  • Added Related Components section linking to Button, IconButton, Select, and Combobox

Test plan

  • Verify the Menu docs page renders correctly on the local docs site at /components/Menu
  • Confirm all Do/Don't tables display properly
  • Confirm Related Components links resolve correctly

Restructure the Menu docs page with clear sections for Summary, Anatomy,
Behavior, Variants, Content Guidelines, Do's and Don'ts, Accessibility,
and Related Components. Content Guidelines now includes Do/Don't tables
for sentence case, verb-first labels, conciseness, context repetition,
verb tense consistency, group labels, and destructive items.

Made-with: Cursor
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 8, 2026

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1f759c5
Status: ✅  Deploy successful!
Preview URL: https://4ee4b705.atlantis.pages.dev
Branch Preview URL: https://menu-docs-edit.atlantis.pages.dev

View logs

@taylorvnoj taylorvnoj self-requested a review May 6, 2026 22:18
Copy link
Copy Markdown
Contributor

@taylorvnoj taylorvnoj left a comment

Choose a reason for hiding this comment

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

@julia-wjw @George-W-M do either of you mind pulling in latest master since this branch is a little old.

Otherwise, just a few small comments


It will have all the same elements as the standard version, and an additional
Overlay covering the non-Menu area.
- A menu item is selected
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.

Optional: unless it's a Menu.RadioGroup setup - but I'm not sure how specific we want to get here

Comment on lines +47 to +49
Menu is positioned below the element that triggered it by default. It should
automatically reposition to appear on the left, right, above, or bottom of the
element that triggers it if the menu is cut off.
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.

Optional: Again maybe this is too specific for this doc section, but we can also control side & align (bottom start, top end, etc)

Comment on lines +63 to +69
#### Menu Items

**1. Action:** Standard one-time actions such as navigating or triggering a
modal **2. SingleSelect:** Persistent choices like a filter of a view
preference. Use when choice persists and the user needs to see which option is
active. **3. Submenu:** Opens a nested menu of options on click and on hover.
Use when related actions are better surfaced one level deeper.
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.

This should probably include the Menu.RadioGroup/RadioItem

Comment on lines +77 to +79
#### Group Label and Divider

Group labels and dividers can be used to separate and group menu items into
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.

Suggested change
#### Group Label and Divider
Group labels and dividers can be used to separate and group menu items into
#### Group Label and Separator
Group labels and separators can be used to separate and group menu items into

maybe makes the "to separate" redundant, but we should avoid calling it a divider, when the component is called Menu.Separator

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.

Good catch!

Copy link
Copy Markdown
Contributor

@taylorvnoj taylorvnoj left a comment

Choose a reason for hiding this comment

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

Thanks @julia-wjw for the follow up and @George-W-M for the original docs!

@taylorvnoj taylorvnoj merged commit 3551470 into master May 8, 2026
14 checks passed
@taylorvnoj taylorvnoj deleted the menu-docs-edit branch May 8, 2026 16:04
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.

3 participants