Docs/modals usage guide#139
Conversation
Introduces detailed usage guides for loading modal, message modal, and custom modal components. Updates sidebar and tab labels for consistency, improves descriptions, and adds related links to progress indicator and toast guides for better documentation navigation.
Revised documentation for loading, message, and custom modals to improve clarity and update usage guidelines. Replaced old Figma illustration links with new ones and added three new illustration assets to the static/figma directory.
|
/gemini review |
![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 pull request introduces comprehensive usage guides for the custom, loading, and message modal components, which is a great addition to the documentation. My review focuses on ensuring the new content aligns with the repository's documentation style guide. I've identified several areas for improvement, primarily concerning consistent phrasing, correct punctuation as per the style guide, and resolving a leftover TODO comment. These changes will help maintain the high quality and consistency of the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…ix-docs into docs/modals-usage-guide
There was a problem hiding this comment.
Finally usage guides on modals, really good! Besides smaller remarks I have two general things:
-
not sure about preserving always the context, I can imagine modals that intentionally bring users somewhere else, e.g. when closing a document "Do you want to save..."
** Cancel/Dismiss → Return to the previous context.
** Primary Action → Can lead to a different context if that aligns with user intent (e.g., saving and navigating away). -
the use of "e.g." in addition with parenthesis is too much in my opinion. I would avoid the use of parenthesis wherever possible
- updated image with unneccessariy annotations removed - Modal: removed whole modal group, simplified sentences, added full stops - Message modal: Simplified sentences, added full stops
- Added images for table - removed parenthesis - aligned message modal to what is really there
Co-authored-by: tokyojen <[email protected]>
…ix-docs into docs/modals-usage-guide
4 participants
💡 What is the current behavior?
There are no usage guides available for modals.
Jira issue: IX-3423
🆕 What is the new behavior?
👨💻 Help & support