Skip to content

feat(docs): write the how to name design tokens post - #93

Merged
alexgrozav merged 2 commits into
blog-uxf-803from
how-to-name-design-tokens-uxf-872
Nov 18, 2026
Merged

alexgrozav merged 2 commits into
blog-uxf-803from
how-to-name-design-tokens-uxf-872

Conversation

@alexgrozav

Copy link
Copy Markdown
Contributor

What changed

The blog's first post, "How to name design tokens", replaces the stub. Its first sentence answers the question on its own: you name a design token by its path, with a double dash between groups and a single dash between words, as in --button--icon--size. Then it walks through the convention in six steps (the scope, semantic names and their tiers, the separators, parts and states, the theme's colours and a component's own variables), each with its reason, the rule ID it comes from and a link to the Design Tokens section that defines it.

The worked examples rename five names, like --blue-2 and --button--font--size, each with the rule it breaks and its new path, then name a tooltip's variables from start to finish and show one path in CSS, DTCG, Figma and Styleframe. The post closes on the Stylelint rule and the page's prompts, linked rather than restated. Every rule in it is the Design Tokens page's, and counterExamples lists each name it shows as wrong.

The Design Tokens page gains one sentence under its intro's list that links to the post, for readers who'd rather be walked through it. Nothing else on the page changes.

Checklist

  • The title follows Conventional Commits, as in feat(docs): add the focus guideline.
  • pnpm check-types passes.
  • Docs changes: the pages read well on pnpm dev. (Checked on the built dist/, in screenshots of the post and the listing at 375px and 1280px, in light and dark mode.)
  • Homepage changes: pnpm build, then pnpm lighthouse, still scores 100 in every category. (No homepage changes, but it passes.)

Replace the stub with the post: six steps, each with its reason, its rule ID and a link to the Design Tokens section it comes from, then worked examples and how to check names. The Design Tokens page links to it under its intro.

Co-authored-by: multica-agent <github@multica.ai>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://how-to-name-design-tokens-uxf-872.opencomponents.dev, https://how-to-name-design-tokens-uxf-872-opencomponents.blue-water-0397.workers.dev (commit 4443ad5)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://261be8f4.opencomponents.dev, https://261be8f4-opencomponents.blue-water-0397.workers.dev 4443ad5 2026-11-18T14:40:00.014Z Visit the dashboard ↗
  • Build: In progress 🔵

View logs ↗
a856941 2026-11-18T14:30:07.558Z View logs ↗

Co-authored-by: multica-agent <github@multica.ai>
@alexgrozav
alexgrozav merged commit 09d76ea into blog-uxf-803 Nov 18, 2026
5 checks passed
@alexgrozav
alexgrozav deleted the how-to-name-design-tokens-uxf-872 branch November 18, 2026 14:41
alexgrozav added a commit that referenced this pull request Nov 19, 2026
…94)

## What changed

opencomponents.dev gets a blog at `/blog`, and its first post is "How to
name design tokens". People search for that question, and the answer is
on the Design Tokens page, spread across a reference. The post walks
through it step by step and sends readers back to the page. Posts aren't
part of the standard, so the MCP server doesn't read them.

The branch brings together three pull requests:

- #92 adds the blog. It's a Nuxt Content collection built like the
changelog, with a listing at `/blog` and a page per post laid out like a
long-form article: a large headline, the standfirst, the author, date
and reading time, then a narrow column of body text. Both headers link
to it after Changelog. Each post has `BlogPosting` structured data, a
place in the sitemap and `llms.txt`, and a Markdown copy at
`/raw/blog/<slug>.md`, served from its source so its tables stay tables.
`pnpm check-seo` now checks all of this. A content check in
`server/lib/blog.test.ts` reads every token name in a post against the
pattern on the Design Tokens page, so the two can't drift apart.
`.github/CONTRIBUTING.md` and `AGENTS.md` describe the blog.
- #93 writes the post. Its first sentence answers the question on its
own. Six steps follow, each with its reason, its rule ID and a link to
the section of the Design Tokens page it comes from, then worked
examples. The Design Tokens page gains one sentence that links to the
post, and nothing else on it changes.
- #95 rewrites the post in the voice of the docs. One example, a theme
and a tooltip, is renamed a step at a time, and each step gives its
reason. Links to the Design Tokens page sit where a reader would want
the detail, in place of a rule ID after every claim. It's shorter, and
only the post's file changes.

Merging this publishes the blog and its first post.

## Checklist

- [x] The title follows [Conventional
Commits](https://www.conventionalcommits.org), as in `feat(docs): add
the focus guideline`.
- [x] `pnpm check-types` passes. (Run on each part, #92 and #93, along
with `pnpm test`, `pnpm check-reference`, `pnpm build`, `pnpm
check-seo`, `pnpm build:mcp` and `pnpm check-mcp`.)
- [x] Docs changes: the pages read well on `pnpm dev`. (Checked on the
built site, in screenshots of the listing and the post at 375px and
1280px, in light and dark mode.)
- [x] Homepage changes: `pnpm build`, then `pnpm lighthouse`, still
scores 100 in every category. (The homepage gains only the Blog link.
Lighthouse passed on each part.)

---------

Co-authored-by: multica-agent <github@multica.ai>
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.

1 participant