Align consumption, testing, and design docs #14
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates documentation wording and structure to consistently describe scopes, failure modes, and terminology across consumption, testing, and design guides.
Changes:
- Standardizes doc frontmatter titles (e.g.,
Testing: …,Design: …,Consumption: …) and adds “Scope” / “Failure if ignored” summaries. - Aligns terminology around mode handling (e.g., “mode key sets”) and integration/consumption naming.
- Expands CSS consumption guidance with cascade layers, modern at-rules, and a checklist.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/testing/visual-regression.md | Title formatting + adds scope/failure summary; clarifies viewport-related failure mode. |
| docs/testing/validation.md | Title formatting + adds scope/failure summary; renames “mode consistency” wording to “mode key sets”. |
| docs/testing/consumption-tests.md | Title formatting + adds scope/failure summary; reframes “framework integration” as “integration outputs”. |
| docs/design/figma-workflow.md | Title formatting; updates workflow language to reference “mode key sets”. |
| docs/design/figma-naming.md | Title formatting + adds scope/failure summary; updates mode-related terminology and formatting. |
| docs/design/component-variables.md | Title formatting + adds scope/failure summary. |
| docs/consumption/typescript.md | Title formatting + adds scope/failure summary. |
| docs/consumption/frameworks.md | Renames section framing from “Frameworks” to “UI Libraries”; updates scope/failure and wording. |
| docs/consumption/css.md | Adds scope/failure summary; improves code formatting and significantly expands advanced CSS guidance. |
Comments suppressed due to low confidence (1)
docs/testing/validation.md:132
- The “Mode key set tests” section calls
testModeKeySets(...)later, but the snippet here still definesfunction testModeConsistency(variables). This makes the doc’s example internally inconsistent. Rename the function in the snippet to match (testModeKeySets) or update the later call/heading to usetestModeConsistencyconsistently.
Test that each collection uses one mode key set:
```javascript
function testModeConsistency(variables) {
const errors = [];
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Out of scope | ||
|
|
||
| - Framework-specific features (see framework docs) | ||
| - React or Vue specific features (see tool docs) |
There was a problem hiding this comment.
This bullet says “React or Vue specific features” but points to “tool docs”. React/Vue are libraries/frameworks, not tools; the reference is unclear/misleading. Consider pointing to the relevant library/framework docs (e.g., React/Vue docs) or renaming “tool docs” to something accurate.
| - React or Vue specific features (see tool docs) | |
| - React- or Vue-specific framework features (see the React and Vue documentation) |
|
|
||
| - CSS-in-JS toolchains (not covered in this spec) | ||
| - PostCSS setup for legacy pipelines (see build pipeline docs) | ||
| - Tailwind or other CSS utility tools (see `docs/adapters/tailwind`) |
There was a problem hiding this comment.
This reference uses inline code docs/adapters/tailwind, which isn’t a clickable internal link and also differs from the link style used elsewhere (e.g. Tailwind Adapter in docs/index.md). Consider changing it to a proper markdown link to the Tailwind adapter doc.
| - Tailwind or other CSS utility tools (see `docs/adapters/tailwind`) | |
| - Tailwind or other CSS utility tools (see [Tailwind Adapter](adapters/tailwind)) |
No description provided.