Problem to Solve
We have:
- Color docs on the EUI site - Never really updated to reflect Borealis - has tokens, but little or outdated guidance or token descriptions.
- "[WIP][EUI Guidelines] Working with colors" doc - Includes guidance as well as a list of tokens with description, but not updated since January, so likely doesn't include the new color tokens we've added.
- I saw a designer point an engineer to this PR for a list of color tokens the other day, which is old and really shouldn't be used as a reference.
There is no reliable source of truth for colors in EUI.
Additionally, a lot of the copy on the color pages pre-date EUI which is likely no longer valid.
Proposed Solution
What I'm envisioning is simplifying and extracting the content of "[WIP][EUI Guidelines] Working with colors" and updating Color docs on the EUI site with that content, so that the EUI docs are the simple source of truth for colors going forward.
After doing so, we should delete or at least update "[WIP][EUI Guidelines] Working with colors" so that it is not redundant with the docs, and makes it clear that the EUI docs are the source of truth.
I would focus on a less-is-more, pratical reference. We don't need to talk about the theory, underlying mechanics, color layers, etc. For example, we don't need to talk about the various layers of color tokens, because the majority of them are not exposed via EUI. Just focus on what is available to EUI users and how and where should they use them.
Additional Context:
These are the two pages that we should focus on:
https://eui.elastic.co/#/theming/colors/values
https://eui.elastic.co/#/utilities/color-palettes
Specifically, these are some thoughts that jump out to me:
I'm unsure whether or not the text is accurate / helpful.
The math doesn't add up on this one -- this is describing a palette of 6 colors. And do we still call them "Brand colors"?
Many colors included could use a description. How and when should colors be applied. I suspect we could use this for all color tokens we have included.
We include deprecated colors in our documentation. I suspect we should just remove these.
Maybe this is a topic for another issue, but for the color palettes page, it's never been quite clear to me when and how we expect folks to use these colors.
Problem to Solve
We have:
There is no reliable source of truth for colors in EUI.
Additionally, a lot of the copy on the color pages pre-date EUI which is likely no longer valid.
Proposed Solution
What I'm envisioning is simplifying and extracting the content of "[WIP][EUI Guidelines] Working with colors" and updating Color docs on the EUI site with that content, so that the EUI docs are the simple source of truth for colors going forward.
After doing so, we should delete or at least update "[WIP][EUI Guidelines] Working with colors" so that it is not redundant with the docs, and makes it clear that the EUI docs are the source of truth.
I would focus on a less-is-more, pratical reference. We don't need to talk about the theory, underlying mechanics, color layers, etc. For example, we don't need to talk about the various layers of color tokens, because the majority of them are not exposed via EUI. Just focus on what is available to EUI users and how and where should they use them.
Additional Context:
These are the two pages that we should focus on:
https://eui.elastic.co/#/theming/colors/values
https://eui.elastic.co/#/utilities/color-palettes
Specifically, these are some thoughts that jump out to me:
I'm unsure whether or not the text is accurate / helpful.
The math doesn't add up on this one -- this is describing a palette of 6 colors. And do we still call them "Brand colors"?
Many colors included could use a description. How and when should colors be applied. I suspect we could use this for all color tokens we have included.
We include deprecated colors in our documentation. I suspect we should just remove these.
Maybe this is a topic for another issue, but for the color palettes page, it's never been quite clear to me when and how we expect folks to use these colors.
