Skip to content

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

Merged
merged 17 commits into from
May 16, 2025

Conversation

LilithJames-HDS
Copy link
Contributor

@LilithJames-HDS LilithJames-HDS commented May 13, 2025

📌 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.

@LilithJames-HDS LilithJames-HDS requested review from a team as code owners May 13, 2025 19:17
Copy link

vercel bot commented May 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview May 16, 2025 1:11pm
hds-website ✅ Ready (Inspect) Visit Preview May 16, 2025 1:11pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label May 13, 2025
shleewhite
shleewhite previously approved these changes May 14, 2025
Copy link
Contributor

@shleewhite shleewhite left a 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.

Copy link
Contributor

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!

Copy link
Contributor

@KristinLBradley KristinLBradley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

jorytindall
jorytindall previously approved these changes May 14, 2025
Copy link
Contributor

@jorytindall jorytindall left a 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.
Copy link
Contributor

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?

Suggested change
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.

Copy link
Contributor Author

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?

Copy link
Contributor

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.


## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[non-blocking suggestion]

Suggested change
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.

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.
Copy link
Contributor

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! 👏

Adopting changes from review comments

Co-authored-by: Jory Tindall <[email protected]>
Co-authored-by: Lee White <[email protected]>
jorytindall
jorytindall previously approved these changes May 15, 2025

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.
Copy link
Contributor

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.

Copy link
Contributor

@shleewhite shleewhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@LilithJames-HDS LilithJames-HDS changed the title Update guidelines.md Update Color page on Helios website (Foundations section) May 16, 2025
Copy link
Contributor

@jorytindall jorytindall left a 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! 🎉

@LilithJames-HDS LilithJames-HDS merged commit 60a3cb8 into main May 16, 2025
11 checks passed
@LilithJames-HDS LilithJames-HDS deleted the lilith-colors-doc-revamp branch May 16, 2025 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants