Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Storybook API docs for menu component #2076

Merged
merged 7 commits into from
May 8, 2024
Merged

Improve Storybook API docs for menu component #2076

merged 7 commits into from
May 8, 2024

Conversation

jattasNI
Copy link
Contributor

@jattasNI jattasNI commented May 7, 2024

Pull Request

🤨 Rationale

Continuing the work done in #2027 in service of #824. This PR covers the menu component.

Example of why this is needed: after documenting the nimble-menu-item change event I searched for usages in SLE and found dozens of instances where apps were using the keyboard inaccessible click event instead. I'm fixing them in this PR.

👩‍💻 Implementation

  1. Refactored menu MDX and story files to follow patterns from previous PRs. I made some judgement calls about where to document child components vs examples; open to feedback on how it turned out!
  2. Added more shared documentation strings and used them in several existing stories.

🧪 Testing

Manual storybook inspection

✅ Checklist

  • I have updated the project documentation to reflect my changes or determined no changes are needed.

@jattasNI jattasNI requested a review from fredvisser May 7, 2024 21:26
@jattasNI jattasNI marked this pull request as ready for review May 7, 2024 21:26
@jattasNI jattasNI requested a review from rajsite as a code owner May 7, 2024 21:26
@jattasNI jattasNI requested a review from rajsite May 8, 2024 14:17
@jattasNI jattasNI merged commit f1d2f1d into main May 8, 2024
11 checks passed
@jattasNI jattasNI deleted the api-docs-2 branch May 8, 2024 15:56
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.

3 participants