Skip to content

chore(#3769): Migrate design system guidelines from the MCP into docs site#3771

Open
twjeffery wants to merge 1 commit intodevfrom
tom/foundations-collection
Open

chore(#3769): Migrate design system guidelines from the MCP into docs site#3771
twjeffery wants to merge 1 commit intodevfrom
tom/foundations-collection

Conversation

@twjeffery
Copy link
Copy Markdown
Collaborator

Closes #3769

The MCP repo has design system guidelines that should be in the docs site. This PR migrates them into the docs site content collections so the per-component ones start showing up on component pages as do's and don'ts right away, and we have a single source of truth to maintain.

What's in this PR

  • New foundations/ content collection (schema in config.ts, documented in ARCHITECTURE.md) for higher-level guidelines
  • 5 foundations files: principles, anti-patterns, user-types, governance, responsive
  • 43 new guidance atoms across forms, layout, feedback, navigation, components, and overlays
  • A few existing radio atoms updated to point at radio-group instead of radio

Notes

  • Foundations content doesn't render on the website yet. The collection exists so the content has a home. Pages can come later if useful.
  • A few atoms describe behavior that should be automatic in the components themselves. I have those captured separately to file as their own small issues.
  • This sets us up for Generate the MCP from docs site content #3770 (generating the MCP from the docs site) so we end up maintaining the content in one place, and also allow us to generate other docs and tools for AI from this single source of truth in the future.

@twjeffery twjeffery requested a review from Spark450 April 9, 2026 06:09
Copy link
Copy Markdown
Collaborator

@Spark450 Spark450 left a comment

Choose a reason for hiding this comment

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

Just a few comments and suggestions.

tags:
- user-types
- citizen
- worker
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 know when I was reviewing the "workspace" docs I pushed to have this term changed to "service delivery worker". Should we align the language in this document as well?

@@ -0,0 +1,15 @@
---
id: linkbutton-vs-link
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.

Should we remove this one, since we are going to undocument the link-button?

---
id: pagination-links-only-mobile
type: tip
description: Use variant='links-only' for a simpler mobile-friendly pagination with just previous and next links.
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 think right now we have buttons instead of links in the pagination control, should we change the description to say "...previous and next buttons"

---
id: picking-a-date-component
type: tip
description: "DatePicker handles most date inputs. Use type='input' (a dropdown for month and text inputs for day and year) for known dates like birthdays, far in the past or far in the future. Use type='calendar' (a popup calendar) for dates closer to real time when the user is picking from available days, like booking or scheduling."
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.

should "for dates closer to real time" instead be: "for dates closer to the current day"

@Spark450 Spark450 requested a review from bdfranck April 10, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate design system guidelines from the MCP into docs site

2 participants