Repository navigation
feat(docs): write the how to name design tokens post - #93
Merged
Merged
Conversation
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>
🚀 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 deploymentPreview Deployments by commit
|
Co-authored-by: multica-agent <github@multica.ai>
4 tasks done
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-2and--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, andcounterExampleslists 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
feat(docs): add the focus guideline.pnpm check-typespasses.pnpm dev. (Checked on the builtdist/, in screenshots of the post and the listing at 375px and 1280px, in light and dark mode.)pnpm build, thenpnpm lighthouse, still scores 100 in every category. (No homepage changes, but it passes.)