oui
oui copied to clipboard
Proposed changes to https://oui.opensearch.org/1.2/#/
My proposed changes are as follows:
-
The headings within the examples on the following pages should be in sentence case (for example, "This is heading one"):
- https://oui.opensearch.org/1.2/#/display/text
- https://oui.opensearch.org/1.2/#/display/text/guidelines
- https://oui.opensearch.org/1.2/#/display/text/playground
-
The table headings on this page should be in sentence case, and “Github” should be styled as “GitHub”:
- Re-add the writing guidelines page. However, I propose the following changes:
- Delete this:
And replace it with this (but make it pretty :smile:):
Source: https://github.com/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#ui-text
- Delete this, which I think is unnecessary. Instead, I would add a note here that, as an exception, proper nouns should always use title case and that our naming conventions should be followed in all cases:
- Add our UI text guidelines to the page, where UX deems appropriate. Links to the UI text section of the style guide are fine where we feel that something is too in the weeds. For example, a link to the Mechanics section may be sufficient.