Skip to content

[CMSDS-4040] Add For Designers page to Doc Site#4079

Open
jack-ryan-nava-pbc wants to merge 3 commits into
mainfrom
jryan/cmsds-4040-for-designers-page
Open

[CMSDS-4040] Add For Designers page to Doc Site#4079
jack-ryan-nava-pbc wants to merge 3 commits into
mainfrom
jryan/cmsds-4040-for-designers-page

Conversation

@jack-ryan-nava-pbc
Copy link
Copy Markdown
Collaborator

Summary

  • Ticket
  • Added a For Designers page!

How to test

  1. Run locally and compare the content on the built page with the content in the PDF in the ticket.

Checklist

  • Prefixed the PR title with the Jira ticket number as [CMSDS-####] 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

@jack-ryan-nava-pbc jack-ryan-nava-pbc added this to the 18.1.0 milestone May 28, 2026
@jack-ryan-nava-pbc jack-ryan-nava-pbc self-assigned this May 28, 2026
@jack-ryan-nava-pbc jack-ryan-nava-pbc added Impacts: Documentation Indicates that this item relates to documentation Type: Added Indicates a new feature. labels May 28, 2026

CMS sets clear expectations for how to use the Design System. Designers **should follow Design System guidance and use its components and patterns** as defined.

If a requirement can't be met using the Design System, document the gap and consider [submitting a contribution proposal](/getting-started/contribution-guidance/) with the Design System team before introducing custom solutions.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Note that the link here deviates from what is in the PDF. I assume that when the PDF was written, we didn't have a Contribution Guidance page?


A [pattern](/patterns/overview/) is a combination of components used together to solve a common user interaction. Examples include form review or utility actions. Patterns are available in both the CMS Design System documentation and Figma.

CMS expects teams to use Design System patterns as outlined. If a pattern doesn't meet your needs, adapt it only if it remains consistent with the Design System's visual language and accessibility guidelines. If you have significant changes from what's outlined in the Design System, document the use case and consider [submitting a contribution proposal](/getting-started/contribution-guidance/).
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Same thing here. Pointing to internal contribution guidance.

Copy link
Copy Markdown
Collaborator

@derek-cmsds derek-cmsds left a comment

Choose a reason for hiding this comment

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

Some incorrect links and a question about icons.

- **[Core](https://design.cms.gov/?theme=core)**: The foundation for the entire Design System. Rarely used by CMS project teams as their default theme.
- **[Healthcare.gov (theme)](https://design.cms.gov/?theme=healthcare)**: For all teams working on [Healthcare.gov](https://healthcare.gov)
- **[Medicare.gov (theme)](https://design.cms.gov/?theme=medicare)**: For all teams working on [Medicare.gov](https://medicare.gov)
- **[CMS.gov (theme)](https://design.cms.gov/?theme=cms)**: For all teams working on [CMS.gov](https://cms.gov)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This link is incorrect. It should be https://design.cms.gov/?theme=cmsgov


### Components

A [component](/components/) is a reusable UI element with a defined function and behavior. These are the building blocks of the Design System. Examples include buttons, checkboxes, and text inputs. Some components have specific usage guidelines that should be followed.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I believe you meant to link to this URL: http://localhost:8000/components/overview/


The CMS Design System uses [Figma](https://www.figma.com/design/OYkYP4pC9jwS7j2qafwmiv/Design-System-Library?m=auto&node-id=718-40190&t=rRYhkftLTZ2TvytT-1) to maintain its visual library.

<Alert hideIcon={true} variation="warn">
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why are we hiding icons? We show them in the For Developers page: https://design.cms.gov/getting-started/for-developers/

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: Added Indicates a new feature.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants