Conversation
New UXW page for the new Messages section. Titled "Overview"
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @tokyojen, 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 introduces a new documentation page dedicated to UX writing guidelines for messages. The page aims to standardize and improve the quality of user-facing messages by offering clear rules, examples, and best practices for different message types, ensuring a more intuitive and user-friendly interface. 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
|
|
Needs to be reviewed by UXW team and then merged and ordered with the whole new messages section in the correct order. |
![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 a new documentation page for UX writing guidelines on messages. The content is comprehensive and well-structured. I've identified several areas for improvement to ensure consistency and adherence to the repository's style guide. My feedback includes corrections for typos, trailing whitespace, inconsistent capitalization, and formatting issues, particularly in the 'Dos and Don'ts' sections. Applying these suggestions will enhance the document's quality and readability.
Removed old pages, updated getting started page and added cross linking
tokyojen
requested review from
kathrinschalber
and removed request for
Susanne254 and
ZsuzsannaRacz
kathrinschalber
left a comment
kathrinschalber
left a comment
There was a problem hiding this comment.
Looking forward to seeing this in our docs 😊 main findings:
- Related section contains absolute or missing links
- Structurally, the use of "General rules" without any other "rules" heading
- Placement/connection of guidelines with matching ix-components
- Some minor formatting topics
| * [Warning messages] | ||
| * [Non-critical information messages] | ||
| * [Error pages] | ||
| * [Empty-state messages] | ||
| * [Form validation] | ||
| * [Message bar] | ||
| * [Toast messages] |
There was a problem hiding this comment.
the links are missing here still
| - Operation stopped for unknown reason. | ||
| </div> | ||
| </div> | ||
| <br/> |
There was a problem hiding this comment.
I noticed that the usage of this extra empty line is used inconsistently.
There was a problem hiding this comment.
what's the reason for not having this directly as 3rd tab on the tooltip component?
(alternatively, we could at least add it on both sides)
| ## Related | ||
|
|
||
| * [Toast messages](./toast-messages.mdx) | ||
| * [Infotips (component)](https://ix.siemens.io/docs/components/tooltip/code#a11y) |
There was a problem hiding this comment.
| * [Infotips (component)](https://ix.siemens.io/docs/components/tooltip/code#a11y) | |
| * [Tooltips (component)](https://ix.siemens.io/docs/components/tooltip) |
Any specific reason you linked the a11y section in the code tab, and that you called them infotips?
There was a problem hiding this comment.
Similar to the feedback on tooltips, might be better placed in the toast component.
Alternatively, you could add it to both places or at least add a link to the toast component in the related section.
| </div> | ||
| </div> | ||
|
|
||
| Use consistent wording from the UI and add specific volumes with progress indicators. |
There was a problem hiding this comment.
| Use consistent wording from the UI and add specific volumes with progress indicators. | |
| Use consistent wording in the UI and add specific volumes with progress indicators. |
Maybe consider adding a dont example
| </div> | ||
| </div> | ||
|
|
||
| <div className="dos-and-donts" markdown="true"> | ||
| <div className="dos" markdown="true"> |
There was a problem hiding this comment.
| </div> | |
| </div> | |
| <div className="dos-and-donts" markdown="true"> | |
| <div className="dos" markdown="true"> |
There was a problem hiding this comment.
Combine them in one block
| * Do add user actions when possible, e.g. buttons or links | ||
| * Don’t leave users wondering if the app is stuck or broken | ||
| * Don’t guess unknown time frames |
There was a problem hiding this comment.
We should never have more donts than dos 😜
|
|
||
| <div className="dos-and-donts" markdown="true"> | ||
| <div className="dos" markdown="true"> | ||
| - Pump 3 cycle complete 14:32. |
There was a problem hiding this comment.
complete -> completes or completed?
| </div> | ||
| <br/> | ||
|
|
||
| Use softening words, i.e. unfortunately and avoid negative contractions (“do not” instead of “don’t”). |
There was a problem hiding this comment.
| Use softening words, i.e. unfortunately and avoid negative contractions (“do not” instead of “don’t”). | |
| Use softening words, e.g. unfortunately and avoid negative contractions (“do not” instead of “don’t”). |
Maybe doublecheck other occurrences
3 participants
New UXW page for the new Messages section. Titled "Overview"
💡 What is the current behavior?
GitHub Issue Number: #
🆕 What is the new behavior?
👨💻 Help & support