-
Notifications
You must be signed in to change notification settings - Fork 49
Update Color page on Helios website (Foundations section) #2870
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
Looks great, just had a couple teeeeeny suggestions.
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
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.
Praise: Love this update to the diagram!
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.
Looks good!
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.
Left a bunch of non-blocking comments and few suggestions, but this is a great round of cleanup!
|
||
Color-naming syntax and usage can vary depending on context and tooling. This overview will clarify what naming conventions are typically used and how they align with the HDS standards implemented in our libraries. | ||
Color-naming syntax and usage can vary depending on context and tooling. Naming conventions within our system allow us to implement standards in our libraries. |
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.
[non-blocking suggestion] This second sentence read slightly weird to me, what do you think about this addition?
Color-naming syntax and usage can vary depending on context and tooling. Naming conventions within our system allow us to implement standards in our libraries. | |
Color-naming syntax and usage can vary depending on context and tooling. Usage-based naming conventions within our system allow us to implement consistent standards in our libraries. |
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.
Do you think calling them usage-based rather than semantic is confusing?
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.
Good point, maybe using "Semantic" instead of usage-based is better here.
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
|
||
## What are semantic colors? | ||
|
||
The Semantic Palette helps ensure proper color usage across applications by embedding meaning directly into the name. | ||
The Semantic Palette embeds meaning into color names, making it easier to select correct consistent values across applications. |
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.
[non-blocking suggestion]
The Semantic Palette embeds meaning into color names, making it easier to select correct consistent values across applications. | |
The Semantic Palette embeds meaning into color names, making it easier to select correct and consistent values across applications. |
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
The **element** and the **role** are referenced in the name to help make more informed color decisions. | ||
### How are semantic names created | ||
|
||
In semantic token naming, the **element** and the **role** are defined to make color decisions easier and more consistent. HDS organizes semantic tokens into **element** categories with **roles** appended. |
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.
This is a great, concise breakdown! 👏
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/foundations/colors/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
089e8be
Co-authored-by: Jory Tindall <[email protected]>
Co-authored-by: Jory Tindall <[email protected]>
Co-authored-by: Lee White <[email protected]>
Co-authored-by: Lee White <[email protected]>
Co-authored-by: Lee White <[email protected]>
Adopting changes from review comments Co-authored-by: Jory Tindall <[email protected]> Co-authored-by: Lee White <[email protected]>
|
||
Color-naming syntax and usage can vary depending on context and tooling. This overview will clarify what naming conventions are typically used and how they align with the HDS standards implemented in our libraries. | ||
Color-naming syntax and usage can vary depending on context and tooling. Naming conventions within our system allow us to implement standards in our libraries. |
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.
Good point, maybe using "Semantic" instead of usage-based is better here.
…rp/design-system into lilith-colors-doc-revamp
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.
Nice!
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.
Nice job with this! 🎉
📌 Summary
If merged, this PR will update the Colors page of the Helios website to make the content more scannable and concise.
I've updated language around the use of color in Figma to briefly explain Variables, cut some content wording to hopefully make the sections more scannable, and updated the images in the Semantic color section to give clearer diagrams of our naming conventions and layers.
Direct link:
https://hds-website-git-lilith-colors-doc-revamp-hashicorp.vercel.app/foundations/colors
🔗 External links
Jira ticket: HDS-4421
👀 Component checklist
💬 Please consider using conventional comments when reviewing this PR.