Skip to content

Commit 041ede4

Browse files
committed
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.
1 parent 1dffa54 commit 041ede4

66 files changed

Lines changed: 240 additions & 165 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/adapters/figma.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# Figma Adapter
@@ -223,7 +224,7 @@ After:
223224

224225
### Step 6: Validate naming
225226

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)).
227228

228229
- Names MUST use dot-separated paths
229230
- Names MUST be lowercase
@@ -365,12 +366,12 @@ Designers author variables in Figma. Changes flow through export, normalization,
365366
2. Design Engineer runs Figma adapter to normalize export JSON.
366367
3. Design Engineer commits normalized JSON to version control.
367368
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)).
369370
6. After merge, CI generates build outputs.
370371

371372
### What gets reviewed
372373

373-
- Variable names follow naming convention ([Naming](/contract/naming.md))
374+
- Variable names follow naming convention ([Naming](/contract/naming))
374375
- References resolve correctly
375376
- Modes are limited (`light`, `dark`)
376377
- No duplicate values when base tokens exist

docs/adapters/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# Adapters
@@ -69,10 +70,10 @@ If adapters fail:
6970

7071
## Adapter documentation
7172

72-
- [Figma Adapter](figma): Figma Variables export normalization
73-
- [Tokens Studio Adapter](tokens-studio): Tokens Studio export normalization
74-
- [Style Dictionary Adapter](style-dictionary): Variable Design Standard (VDS) to CSS/TypeScript/etc.
75-
- [Tailwind Adapter](tailwind): Tailwind theme configuration generation
73+
- [Figma Adapter](adapters/figma): Figma Variables export normalization
74+
- [Tokens Studio Adapter](adapters/tokens-studio): Tokens Studio export normalization
75+
- [Style Dictionary Adapter](adapters/style-dictionary): Variable Design Standard (VDS) to CSS/TypeScript/etc.
76+
- [Tailwind Adapter](adapters/tailwind): Tailwind theme configuration generation
7677

7778
## Out of scope
7879

docs/adapters/style-dictionary.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# Style Dictionary Adapter
@@ -272,7 +273,7 @@ Output (`dist/theme.css`):
272273
}
273274
```
274275

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.
276277

277278
## Links
278279

docs/adapters/tailwind.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Adapters: Tailwind"
3+
description: "Tailwind CSS v4 integration patterns for Variable Design Standard (VDS). Generate CSS custom properties from Variable Design Standard (VDS) JSON using Tailwind CSS v4's CSS-first approach."
34
---
45

56
# Tailwind Adapter

docs/adapters/tokens-studio.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# Tokens Studio Adapter
@@ -74,7 +75,7 @@ This format is already correct. No conversion needed.
7475

7576
### Step 4: Validate naming
7677

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)).
7879

7980
- Names MUST use dot-separated paths
8081
- Names MUST be lowercase
@@ -204,12 +205,12 @@ Designers author variables in Figma using Tokens Studio plugin. The repo JSON is
204205
2. Design Engineer validates export JSON (run adapter if needed).
205206
3. Design Engineer commits JSON to version control.
206207
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)).
208209
6. After merge, CI validates JSON and generates build outputs.
209210

210211
### What gets reviewed
211212

212-
- Variable names follow naming convention ([Naming](/contract/naming.md))
213+
- Variable names follow naming convention ([Naming](/contract/naming))
213214
- References resolve correctly
214215
- Token organization (base, semantic, component layers)
215216
- Breaking changes are documented
@@ -232,7 +233,7 @@ Before exporting from Tokens Studio:
232233
- Semantic aliases: reference base tokens, describe usage
233234
- Component tokens: reference semantic aliases, component-scoped
234235

235-
See [Anatomy](/contract/anatomy.md) for details.
236+
See [Anatomy](/contract/anatomy) for details.
236237

237238
### Artifacts that change
238239

docs/adoption/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Adoption: Getting Started"
3+
description: "Team adoption steps for Variable Design Standard (VDS)."
34
---
45

56
# Team Adoption Guide
@@ -342,8 +343,8 @@ Avoid these mistakes:
342343

343344
After adoption:
344345

345-
- Review [Implementation Checklist](adoption/implementation-checklist)
346-
- Set up [Migration Strategy](adoption/migration-strategy) if migrating
346+
- Review [Implementation Checklist](implementation-checklist)
347+
- Set up [Migration Strategy](migration-strategy) if migrating
347348
- Document team-specific patterns
348349
- Iterate on workflow
349350

docs/adoption/implementation-checklist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Adoption: Implementation Checklist"
3+
description: "Pre-implementation, implementation, and post-implementation checklists for Variable Design Standard (VDS) adoption."
34
---
45

56
# Implementation Checklist
@@ -129,7 +130,7 @@ To claim Variable Design Standard (VDS) compliance, verify:
129130
- [ ] File selection rule documented (brand and mode folders)
130131
- [ ] Contract review gate defined
131132

132-
See [Conformance](reference/conformance) for complete conformance requirements.
133+
See [Conformance](../reference/conformance) for complete conformance requirements.
133134

134135
## Post-implementation validation
135136

docs/adoption/migration-strategy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Adoption: Migration Strategy"
3+
description: "Phased migration steps from existing variable systems to Variable Design Standard (VDS)."
34
---
45

56
# Phased Migration Strategy

docs/consumption/css.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# CSS Variable Consumption

docs/consumption/frameworks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
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."
34
---
45

56
# UI Library Integration

0 commit comments

Comments
 (0)