docs(vertical-navigation): update ux docs #1370
Conversation
panch1739
added
documentation
Summary of ChangesHello @panch1739, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the user experience documentation for the vertical navigation component. The changes primarily focus on refining the guidelines for badge implementation to align with a new design, ensuring clarity on their display behavior in various states, particularly within submenus and when the navigation is collapsed. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR updates the documentation for badges within the vertical navigation component. The added details about behavior in submenus and in the collapsed state are a good improvement. I've added one comment to resolve a contradiction in the new text for better clarity. Also, note that while the PR description mentions updated images, no image files were changed in this PR, which might lead to an inconsistency between the text and the visuals.
| Items can also include [badges](../status-notifications/badges.md) to provide users with quick, at-a-glance information, | ||
| such as notifications or counts. For sub menus, badges should only be used on child elements. | ||
| Items can also include [badges](../status-notifications/badges.md) to provide users with quick, at-a-glance information. | ||
| For submenus, badges are used only on child items. The parent item does not display a badge, except in the collapsed state. |
There was a problem hiding this comment.
The first clause, 'For submenus, badges are used only on child items,' contradicts the second clause, 'The parent item does not display a badge, except in the collapsed state.' If badges are used only on child items, a parent item would never have a badge to display in any state. This phrasing is confusing. To improve clarity, I suggest rephrasing to focus on the display behavior.
| For submenus, badges are used only on child items. The parent item does not display a badge, except in the collapsed state. | |
| For submenus, badges are displayed on child items. The parent item only displays a badge when the navigation is collapsed. |
|
|
|
Documentation. Coverage Reports: |
hbxes
left a comment
hbxes
left a comment
There was a problem hiding this comment.
All good, just one question about the search in the collapsed version, it looks like not active or disabled.
There was a problem hiding this comment.
The search looks like disabled in the image, maybe we have to reconsider the color of the search icon in the default state...
This PR updates the images of the vertical navigation for new design.