Docs/uxw/warning messages new 2 - testpurpose #173
Conversation
formatting does and don'ts for progress updates added
…emens/ix-docs into docs/uxw/warning-messages-new
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @varun-srinivasa, 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 significantly enhances the iX Design System's documentation by introducing comprehensive UX writing guidelines for various message types, such as non-critical information, progress updates, time-related notifications, toast messages, and tooltips. These additions aim to standardize user communication, improve clarity, and ensure a consistent user experience. Furthermore, the changes include crucial updates to Angular integration instructions, detailed migration notes for specific components, and practical advice on component readiness and rendering, all contributing to a more robust and user-friendly development experience. Highlights
Ignored Files
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 pull request introduces several new documentation pages and updates existing ones. The changes include dependency updates, additions to the migration guide, and fixes for class attributes in MDX files. My review focuses on ensuring the new documentation adheres to the repository's style guide, particularly regarding typography (apostrophes), MDX syntax, and heading formats. I've also identified a typo in the frontmatter of a new file.
| @@ -0,0 +1,162 @@ | |||
| --- | |||
| sidebar_position: 99 | |||
| Sidebar_lable: Non-critical information messages | |||
There was a problem hiding this comment.
There's a typo in the frontmatter. Sidebar_lable should be sidebar_label.
sidebar_label: Non-critical information messages
|
|
||
| ### Keep messages short and concise. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue is present in multiple div elements throughout this new file. Please correct all occurrences to ensure the components render correctly.
<div className="dos-and-donts" markdown="true">
| </div> | ||
| </div> | ||
|
|
||
| ## Dos and Don'ts |
There was a problem hiding this comment.
The heading Dos and Don'ts does not follow the style guide. According to line 91 of the repository style guide, the title should be Dos and Don’ts, using a right single quotation mark.
## Dos and Don’ts
References
- The title is "Dos and Don’ts" (link)
|
|
||
| ## Use sentence case to align with our UX writing guidelines. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue occurs multiple times in this file within dos-and-donts divs. Please correct all instances.
<div className="dos-and-donts" markdown="true">
| </div> | ||
| </div> | ||
|
|
||
| ## Avoid ellipses to show time remaining and approximate or unknown times as they're status indicators, not actions. |
There was a problem hiding this comment.
The apostrophe in they're is incorrect. Per the style guide (line 35), please use the right single quotation mark (’, U+2019).
## Avoid ellipses to show time remaining and approximate or unknown times as they’re status indicators, not actions.
References
- Apostrophe: Always use the symbol ’ (U+2019, "right single quotation mark"), not ' (link)
|
|
||
| ### Use a specific time or time frame whenever possible. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue occurs multiple times in this file within dos-and-donts divs. Please correct all instances.
<div className="dos-and-donts" markdown="true">
|
|
||
| ### Use simple past tense verbs to state what happened. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue occurs multiple times in this file within dos-and-donts divs. Please correct all instances.
<div className="dos-and-donts" markdown="true">
|
|
||
| ### Use tooltips to define icons and show control names. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue occurs multiple times in this file within dos-and-donts divs. Please correct all instances.
<div className="dos-and-donts" markdown="true">
|
|
||
| ### Use warning messages only when an action or awareness is genuinely needed. | ||
|
|
||
| <div class="dos-and-donts" markdown> |
There was a problem hiding this comment.
In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue occurs multiple times in this file within dos-and-donts divs. Please correct all instances.
<div className="dos-and-donts" markdown="true">
💡 What is the current behavior?
GitHub Issue Number: #
🆕 What is the new behavior?
👨💻 Help & support