[EUI+] Polish pass on all docs callouts #8107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…elements - particularly for `<ol>/<ul>` elements followed by a callout
…ing`s, + add accessibility-related titles - this feels friendlier and will generally (IMO) make devs more likely to read them and consider warnings + fix duplicate titles/headers along the way + tweak copy to be more succinct in places
- use tip and danger callout types to match do/don't guidelines and better match the intention of the callout copy
- more friendly and helpful to denote callouts that are more usage guidelines or nice-to-haves + remove duplicate content + minor copy tweaks
IMO, a `warning` should be used if component UI/UX will break in some way if the warning is not read The `info` status can be more generic, or apply to specific techncial DX
- should be using EUI components as part of the example
- just use sub-bullet-points instead
- the text is short enough IMO that this is easier readability
cee-chen
added
documentation
|
Preview staging links for this PR:
|
💚 Build Succeeded
|
mgadewoll
approved these changes
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
QA polish pass on EUI+'s callouts in our docs copy:
tipcallout type)notelevels instead ofwarninglevels - IMO, this is friendlier and easier to read. Long term, It might be neat to add our own custom:::accessibilitycallout type for this with a custom icon 👀QA
General checklist
N/A, EUI+ docs only