-
Notifications
You must be signed in to change notification settings - Fork 29
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
[UI/UX] Documentation about Notifications use #191
base: 5.x
Are you sure you want to change the base?
Conversation
@RCheesley Could you give me basic access to the repository? The same as mautic/mautic |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! I've fixed a few of the Vale warnings with suggestions, which for some reason didn't get flagged up in the PR, I think maybe the alert level has been reduced. These show up when using Vale locally in VSCode.
Notifications | ||
============= | ||
|
||
Notifications are a critical component of user experience (UX) in digital products, serving as a bridge between the system and the user. They should enhance, not detract from, the user experience, assisting users in achieving their goals and providing immediate, relevant feedback. This guide synthesizes best practices from the Carbon Design System and industry standards to help developers create effective and user-friendly notifications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be helpful to link out to the Carbon Design System here?
You can use the command 'make link' in the terminal, to create the link file. It will tell you what code to include to generate the link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, it was a mistake to leave this part there
Without more instructions, devs could have issues to understand since Carbon uses React while my implementation is based on Bootstrap
Carbon could be useful for the dev creating/changing components appearance, but it will probably be unusable for the ones who just want to create the code without thinking about how it's going to look in details...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean, perhaps the dev experience here would be like "Just put a div with the classes alert and the other you want then you're good to go, the UI will happen magically"
@RCheesley Which extension do you use on VS Code? |
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
…l/developer-documentation-new into docs-notifications
If you clone this repo, the extensions should all be installed for you. Just the regular Vale one. It lints as you write, blue squiggles = suggestion, yellow = warning, red=error. |
This PR teaches devs on how to use notifications and expected behaviour.