Skip to content

Commit c78ac2b

Browse files
committed
docs: update documentation links and improve navigation
- Renamed "Variable Contract" to "Variables Contract" for consistency across documentation. - Updated internal links to use relative paths instead of absolute paths for better portability. - Enhanced navigation by correcting links in various sections, including adapters, governance, and contract documentation. - Added new HTML files for site structure, including adapters, adoption, and governance sections, improving overall accessibility and organization.
1 parent e2a537c commit c78ac2b

File tree

99 files changed

+108834
-129
lines changed

Some content is hidden

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

99 files changed

+108834
-129
lines changed

docs/adapters/figma.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ After:
212212

213213
### Step 6: Validate naming
214214

215-
Check that normalized names follow Variable Contract naming convention (see [Naming](/variables-contract/adapters/contract/naming)).
215+
Check that normalized names follow Variable Contract naming convention (see [Naming](../contract/naming)).
216216

217217
- Names MUST use dot-separated paths
218218
- Names MUST be lowercase
@@ -354,12 +354,12 @@ Designers author variables in Figma. Changes flow through export, normalization,
354354
2. Design Engineer runs Figma adapter to normalize export JSON.
355355
3. Design Engineer commits normalized JSON to version control.
356356
4. Design Engineer opens PR for review.
357-
5. Reviewers check naming, types, references (see [Change Control](/variables-contract/adapters/governance/change-control)).
357+
5. Reviewers check naming, types, references (see [Change Control](../governance/change-control)).
358358
6. After merge, CI generates build outputs.
359359

360360
### What gets reviewed
361361

362-
- Variable names follow naming convention ([Naming](/variables-contract/adapters/contract/naming))
362+
- Variable names follow naming convention ([Naming](../contract/naming))
363363
- References resolve correctly
364364
- Modes are limited (`light`, `dark`)
365365
- No duplicate values when base tokens exist

docs/adapters/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ If adapters fail:
6969

7070
## Adapter documentation
7171

72-
- [Figma Adapter](/variables-contract/adapters/figma) - Figma Variables export normalization
73-
- [Tokens Studio Adapter](/variables-contract/adapters/tokens-studio) - Tokens Studio export normalization
74-
- [Style Dictionary Adapter](/variables-contract/adapters/style-dictionary) - Variable Contract to CSS/TypeScript/etc.
75-
- [Tailwind Adapter](/variables-contract/adapters/tailwind) - Tailwind theme configuration generation
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 Contract to CSS/TypeScript/etc.
75+
- [Tailwind Adapter](tailwind) - Tailwind theme configuration generation
7676

7777
## Out of scope
7878

docs/adapters/tokens-studio.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This format is already correct. No transformation needed.
7474

7575
### Step 4: Validate naming
7676

77-
Check that names follow Variable Contract naming convention (see [Naming](/variables-contract/adapters/contract/naming)).
77+
Check that names follow Variable Contract naming convention (see [Naming](../contract/naming)).
7878

7979
- Names MUST use dot-separated paths
8080
- Names MUST be lowercase
@@ -204,12 +204,12 @@ Designers author variables in Figma using Tokens Studio plugin. The repo JSON is
204204
2. Design Engineer validates export JSON (run adapter if needed).
205205
3. Design Engineer commits JSON to version control.
206206
4. Design Engineer opens PR for review.
207-
5. Reviewers check naming, types, references (see [Change Control](/variables-contract/adapters/governance/change-control)).
207+
5. Reviewers check naming, types, references (see [Change Control](../governance/change-control)).
208208
6. After merge, CI validates JSON and generates build outputs.
209209

210210
### What gets reviewed
211211

212-
- Variable names follow naming convention ([Naming](/variables-contract/adapters/contract/naming))
212+
- Variable names follow naming convention ([Naming](../contract/naming))
213213
- References resolve correctly
214214
- Token organization (base, semantic, component layers)
215215
- Breaking changes are documented
@@ -232,7 +232,7 @@ Before exporting from Tokens Studio:
232232
- Semantic aliases: reference base tokens, describe usage
233233
- Component tokens: reference semantic aliases, component-scoped
234234

235-
See [Anatomy](/variables-contract/adapters/contract/anatomy) for details.
235+
See [Anatomy](../contract/anatomy) for details.
236236

237237
### Artifacts that change
238238

docs/adoption/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,8 @@ Avoid these mistakes:
251251

252252
After adoption:
253253

254-
- Review [Implementation Checklist](/variables-contract/adoption/adoption/implementation-checklist)
255-
- Set up [Migration Strategy](/variables-contract/adoption/adoption/migration-strategy) if migrating
254+
- Review [Implementation Checklist](adoption/implementation-checklist)
255+
- Set up [Migration Strategy](adoption/migration-strategy) if migrating
256256
- Document team-specific patterns
257257
- Iterate on workflow
258258

docs/contract/anatomy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ If anatomy rules are ignored:
7777

7878
- Specific variable values (anatomy governs structure, not content)
7979
- Number of variables per category (depends on design system size)
80-
- Naming within categories (see [Naming Convention](/variables-contract/contract/naming))
80+
- Naming within categories (see [Naming Convention](naming))

docs/contract/dtcg-alignment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ DTCG 2025.10 defines:
2525

2626
Variable Contract adds a governance layer on top of DTCG format:
2727

28-
- Naming convention rules (see [Naming](/variables-contract/contract/naming))
29-
- Change control process (see [Change Control](/variables-contract/governance/change-control))
30-
- Role definitions (see [Design Engineer](/variables-contract/governance/roles/design-engineer))
31-
- Adapter patterns for tool integration (see [Adapters](/variables-contract/adapters))
28+
- Naming convention rules (see [Naming](naming))
29+
- Change control process (see [Change Control](../governance/change-control))
30+
- Role definitions (see [Design Engineer](../governance/roles/design-engineer))
31+
- Adapter patterns for tool integration (see [Adapters](../adapters))
3232
- Validation requirements beyond format correctness
3333

3434
## Compatibility matrix

docs/contract/types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Examples:
257257

258258
## Composite types
259259

260-
Composite types combine multiple primitive types into structured values. See [Composite Types](/variables-contract/contract/composite-types) for details.
260+
Composite types combine multiple primitive types into structured values. See [Composite Types](composite-types) for details.
261261

262262
Supported composite types:
263263

docs/contract/variable-contract.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ If the contract is loose, you get silent renames, broken references, and "same v
1010

1111
## DTCG compliance
1212

13-
This contract is DTCG 2025.10 compliant. See [DTCG Alignment](/variables-contract/contract/dtcg-alignment) for details.
13+
This contract is DTCG 2025.10 compliant. See [DTCG Alignment](dtcg-alignment) for details.
1414

1515
## Inputs and adapters
1616

1717
This contract defines the canonical shape used in version control.
1818

1919
Tool exports (example: a Figma variable export JSON) are treated as inputs. They may include extra metadata and alternate reference syntax. An adapter can normalize those inputs into this contract.
2020

21-
See [Adapters](/variables-contract/adapters) for adapter patterns and implementations.
21+
See [Adapters](../adapters) for adapter patterns and implementations.
2222

2323
## Adapter pipeline
2424

@@ -40,7 +40,7 @@ A variable is an object with the following properties:
4040

4141
A group is an object that contains nested groups and/or variables. Groups do not have `$type`/`$value`.
4242

43-
Groups can extend other groups using `$ref`. See [Groups](/variables-contract/contract/groups) for details.
43+
Groups can extend other groups using `$ref`. See [Groups](groups) for details.
4444

4545
## `$type`
4646

@@ -52,7 +52,7 @@ Rules:
5252
- A variable's `$type` must not change unless it is a breaking change.
5353
- Composite types must use the expected structure for that type.
5454

55-
See [Types](/variables-contract/contract/types) for the complete type reference and [Composite Types](/variables-contract/contract/composite-types) for structured types.
55+
See [Types](types) for the complete type reference and [Composite Types](composite-types) for structured types.
5656

5757
## `$value`
5858

@@ -75,7 +75,7 @@ Rules:
7575
- Mode names should not change without a breaking change.
7676
- A mode value may be a literal value or a reference.
7777

78-
See [Modes](/variables-contract/contract/modes) for complete mode documentation including structure, resolution, and consistency rules.
78+
See [Modes](modes) for complete mode documentation including structure, resolution, and consistency rules.
7979

8080
## References (aliases)
8181

@@ -101,7 +101,7 @@ Rules:
101101
- JSON Pointer syntax is supported for DTCG compliance.
102102
- Tool-specific reference formats are allowed only as adapter inputs.
103103

104-
See [References](/variables-contract/contract/references) for complete reference documentation including resolution algorithms, chained references, and property-level references.
104+
See [References](references) for complete reference documentation including resolution algorithms, chained references, and property-level references.
105105

106106
## `$description`
107107

@@ -137,15 +137,15 @@ Rules:
137137

138138
A change is considered valid if:
139139

140-
- Names follow the naming convention ([Naming](/variables-contract/contract/naming)).
140+
- Names follow the naming convention ([Naming](naming)).
141141
- Every variable has `$type` and `$value`.
142-
- References resolve and are acyclic (see [References](/variables-contract/contract/references)).
142+
- References resolve and are acyclic (see [References](references)).
143143
- References use the canonical reference syntax (`{path}`).
144144
- If `$value` uses modes, mode keys are explicit and shared within a collection.
145145
- Alias variables do not duplicate raw palette values when a base variable exists.
146146
- Component variables do not reference base variables directly unless explicitly documented.
147147
- Breaking changes are versioned and documented (rename, removal, `$type` change).
148-
- Group extensions (`$ref`) do not create circular references (see [Groups](/variables-contract/contract/groups)).
148+
- Group extensions (`$ref`) do not create circular references (see [Groups](groups)).
149149

150150
## Conformance
151151

@@ -157,7 +157,7 @@ Variable Contract conformance requires:
157157
- Validation implementation
158158
- Versioning compliance
159159

160-
See [Conformance](/variables-contract/reference/conformance) for complete conformance requirements and how to claim compliance.
160+
See [Conformance](../reference/conformance) for complete conformance requirements and how to claim compliance.
161161

162162
## Out of scope
163163

docs/examples/adapter-pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Figma Variables export JSON:
5757

5858
## Step 2: Figma adapter normalization
5959

60-
After running the Figma adapter (see [Figma Adapter](/variables-contract/examples/adapters/figma)):
60+
After running the Figma adapter (see [Figma Adapter](adapters/figma)):
6161

6262
```json
6363
{

docs/examples/figma-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is an example input file shape from a Figma Variables export.
88

99
- Raw file: `figma-export.json`
1010

11-
This export format includes Figma-specific metadata and reference syntax. Use the [Figma Adapter](/variables-contract/adapters/figma) to normalize it into the canonical contract format defined in [Variable Contract](/variables-contract/contract/variable-contract).
11+
This export format includes Figma-specific metadata and reference syntax. Use the [Figma Adapter](../../adapters/figma) to normalize it into the canonical contract format defined in [Variable Contract](../../contract/variable-contract).
1212

1313
## Normalization required
1414

@@ -20,4 +20,4 @@ Figma exports need normalization before use:
2020
4. Convert reference syntax (`{@collection.token}``{collection.token}`)
2121
5. Move mode values from metadata to `$value` objects
2222

23-
See [Figma Adapter](/variables-contract/examples/adapters/figma) for complete normalization steps.
23+
See [Figma Adapter](../adapters/figma) for complete normalization steps.

0 commit comments

Comments
 (0)