Skip to content
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.

Sign up for GitHub

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

[EUI+] Polish pass on all docs callouts #8107

Merged
merged 10 commits into from
Oct 31, 2024
Merged

[EUI+] Polish pass on all docs callouts #8107

merged 10 commits into from
Oct 31, 2024

Commits on Oct 29, 2024

  1. Ensure callouts always receive appropriate margin-top from preceding … 

    …elements

- particularly for `<ol>/<ul>` elements followed by a callout
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    50a0ff2 View commit details
    Browse the repository at this point in the history

  2. Switch all accessibility-related callouts to notes instead of `warn… 

    …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
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    949dad9 View commit details
    Browse the repository at this point in the history

  3. Improve callouts on accessibility guidelines page 

    - use tip and danger callout types to match do/don't guidelines and better match the intention of the callout copy
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    81bd4b6 View commit details
    Browse the repository at this point in the history

  4. Tweak more callouts to use the new tip type 

    - more friendly and helpful to denote callouts that are more usage guidelines or nice-to-haves

+ remove duplicate content
+ minor copy tweaks
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    5d09a9a View commit details
    Browse the repository at this point in the history

  5. Adjust a few more info vs warning levels 

    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
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    c21837b View commit details
    Browse the repository at this point in the history

  6. Remove remaining duplicate callout titles

    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    b981809 View commit details
    Browse the repository at this point in the history

  7. Misc callout copy improvements/tweaks

    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    c1b821b View commit details
    Browse the repository at this point in the history

  8. Fix incorrect docusaurus callout MDX in writing guidelines 

    - should be using EUI components as part of the example
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    4847ace View commit details
    Browse the repository at this point in the history

  9. Remove EuiDataGrid docs callout mdx nested within bullet points 

    - just use sub-bullet-points instead
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    8479b41 View commit details
    Browse the repository at this point in the history

  10. Remove extra newlines for docs callouts with no titles 

    - the text is short enough IMO that this is easier readability
    @cee-chen
    cee-chen committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    2227f34 View commit details
    Browse the repository at this point in the history