You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation with enhanced descriptions and fixed links
- Added detailed descriptions to various sections to improve clarity and context.
- Fixed broken links by ensuring correct paths and appending .md extensions where necessary.
- Updated frontmatter titles for consistency and formatting.
- Refined references to ensure they point to the correct locations within the documentation.
Copy file name to clipboardExpand all lines: docs/adapters/figma.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Adapters: Figma"
3
+
description: "Figma Variables exports include tool-specific metadata and reference syntax. This adapter normalizes Figma exports into Variable Design Standard (VDS) format."
3
4
---
4
5
5
6
# Figma Adapter
@@ -223,7 +224,7 @@ After:
223
224
224
225
### Step 6: Validate naming
225
226
226
-
Check that normalized names follow Variable Design Standard (VDS) naming convention (see [Naming](/contract/naming.md)).
227
+
Check that normalized names follow Variable Design Standard (VDS) naming convention (see [Naming](/contract/naming)).
227
228
228
229
- Names MUST use dot-separated paths
229
230
- Names MUST be lowercase
@@ -365,12 +366,12 @@ Designers author variables in Figma. Changes flow through export, normalization,
365
366
2. Design Engineer runs Figma adapter to normalize export JSON.
366
367
3. Design Engineer commits normalized JSON to version control.
367
368
4. Design Engineer opens PR for review.
368
-
5. Reviewers check naming, types, references (see [Change Control](/governance/change-control.md)).
369
+
5. Reviewers check naming, types, references (see [Change Control](/governance/change-control)).
Copy file name to clipboardExpand all lines: docs/adapters/index.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Adapters: Overview"
3
+
description: "Adapters normalize tool outputs into Variable Design Standard (VDS) format and transform Variable Design Standard (VDS) format into tool inputs."
Copy file name to clipboardExpand all lines: docs/adapters/style-dictionary.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Adapters: Style Dictionary"
3
+
description: "Style Dictionary consumes Variable Design Standard (VDS) (DTCG) format and generates platform outputs like CSS variables, TypeScript types, and Tailwind CSS v4 custom properties."
3
4
---
4
5
5
6
# Style Dictionary Adapter
@@ -272,7 +273,7 @@ Output (`dist/theme.css`):
272
273
}
273
274
```
274
275
275
-
Note: Tailwind CSS v4 uses CSS-first configuration. Generate CSS custom properties, not JavaScript config files. See [Tailwind Adapter](adapters/tailwind) for details.
276
+
Note: Tailwind CSS v4 uses CSS-first configuration. Generate CSS custom properties, not JavaScript config files. See [Tailwind Adapter](/adapters/tailwind) for details.
Copy file name to clipboardExpand all lines: docs/adapters/tokens-studio.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Adapters: Tokens Studio"
3
+
description: "Tokens Studio exports are close to Variable Design Standard (VDS) format but may include Tokens Studio-specific metadata. This adapter normalizes Tokens Studio exports."
3
4
---
4
5
5
6
# Tokens Studio Adapter
@@ -74,7 +75,7 @@ This format is already correct. No conversion needed.
74
75
75
76
### Step 4: Validate naming
76
77
77
-
Check that names follow Variable Design Standard (VDS) naming convention (see [Naming](/contract/naming.md)).
78
+
Check that names follow Variable Design Standard (VDS) naming convention (see [Naming](/contract/naming)).
78
79
79
80
- Names MUST use dot-separated paths
80
81
- Names MUST be lowercase
@@ -204,12 +205,12 @@ Designers author variables in Figma using Tokens Studio plugin. The repo JSON is
204
205
2. Design Engineer validates export JSON (run adapter if needed).
205
206
3. Design Engineer commits JSON to version control.
206
207
4. Design Engineer opens PR for review.
207
-
5. Reviewers check naming, types, references (see [Change Control](/governance/change-control.md)).
208
+
5. Reviewers check naming, types, references (see [Change Control](/governance/change-control)).
208
209
6. After merge, CI validates JSON and generates build outputs.
Copy file name to clipboardExpand all lines: docs/consumption/css.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Consumption: CSS"
3
+
description: "CSS consumption patterns for Variable Design Standard (VDS) outputs. Use CSS custom properties generated from Variable Design Standard (VDS) JSON."
Copy file name to clipboardExpand all lines: docs/consumption/frameworks.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: "Consumption: UI Libraries"
3
+
description: "UI library integration using Variable Design Standard (VDS) outputs. Use CSS variables, TypeScript types, and theme context in React and Vue components."
0 commit comments