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.

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

[WNMGDS-3160] Updates docs site color guidance #3395

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

kim-cmsds
Copy link
Collaborator

Summary

  • Updates the "theme colors" page on the docs site to programmatically display information about certain color categories (e.g. "primary" or "base")
  • Jira Ticket
  • There's a function that is looping over the color tokens multiple times to determine the information that designs will want to see (e.g. hexcode, css variable name, the name of the color in figma, and component usage). There's probably a better way of accomplishing this information gathering, so feel free to leave feedback on that front.

This work can also be reviewed at https://cmsgov.github.io/design-system/branch/kcn/3160/update-color-guidance/foundation/theme-colors/?theme=core

@sophia-cmsds and @andream-cmsds I'm particularly interested in addressing any feedback you might have! We can talk more about ways to define specific commentary about each color category. You'll find it's generic now, but that can be addressed.

How to test

  1. Pull down the branch locally and take a look at http://localhost:8000/foundation/theme-colors/
  2. Compare what's there with the design found in the JIRA ticket

Checklist

  • Prefixed the PR title with the Jira ticket number as [WNMGDS-####] Title or [NO-TICKET] if this is unticketed work.
  • Selected appropriate Type (only one) label for this PR, if it is a breaking change, label should only be Type: Breaking
  • Selected appropriate Impacts, multiple can be selected.
  • Selected appropriate release milestone

If this is a change to documentation:

  • Checked for spelling and grammatical errors

@kim-cmsds kim-cmsds added Impacts: Documentation Indicates that this item relates to documentation Type: Changed Indicates a change to an existing element of the DS. labels Jan 16, 2025
@kim-cmsds kim-cmsds added this to the 12.1.0 milestone Jan 16, 2025
Copy link
Collaborator

@sophia-cmsds sophia-cmsds left a comment

Choose a reason for hiding this comment

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

This looks great! In a perfect world there'd be a way for Andrea or I to be able to edit the content (specifically "used in") without triggering a whole release process but either way this is a vast improvement over the existing.

Also I know I owe you the feedback link still!

Copy link
Collaborator

@andream-cmsds andream-cmsds left a comment

Choose a reason for hiding this comment

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

This looks amazing! One thing I noticed is off is that for the HealthCare theme, the +/- on the accordions is on the far right, but in our Figma files, they are on the left of the accordion heading. (Attaching a Figma screenshot)
Screenshot 2025-01-17 at 12 49 33 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impacts: Documentation Indicates that this item relates to documentation Type: Changed Indicates a change to an existing element of the DS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants