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
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.
Copy file name to clipboardExpand all lines: docs/contract/types.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -257,7 +257,7 @@ Examples:
257
257
258
258
## Composite types
259
259
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.
Copy file name to clipboardExpand all lines: docs/contract/variable-contract.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,15 @@ If the contract is loose, you get silent renames, broken references, and "same v
10
10
11
11
## DTCG compliance
12
12
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.
14
14
15
15
## Inputs and adapters
16
16
17
17
This contract defines the canonical shape used in version control.
18
18
19
19
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.
20
20
21
-
See [Adapters](/variables-contract/adapters) for adapter patterns and implementations.
21
+
See [Adapters](../adapters) for adapter patterns and implementations.
22
22
23
23
## Adapter pipeline
24
24
@@ -40,7 +40,7 @@ A variable is an object with the following properties:
40
40
41
41
A group is an object that contains nested groups and/or variables. Groups do not have `$type`/`$value`.
42
42
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.
44
44
45
45
## `$type`
46
46
@@ -52,7 +52,7 @@ Rules:
52
52
- A variable's `$type` must not change unless it is a breaking change.
53
53
- Composite types must use the expected structure for that type.
54
54
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.
56
56
57
57
## `$value`
58
58
@@ -75,7 +75,7 @@ Rules:
75
75
- Mode names should not change without a breaking change.
76
76
- A mode value may be a literal value or a reference.
77
77
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.
79
79
80
80
## References (aliases)
81
81
@@ -101,7 +101,7 @@ Rules:
101
101
- JSON Pointer syntax is supported for DTCG compliance.
102
102
- Tool-specific reference formats are allowed only as adapter inputs.
103
103
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.
105
105
106
106
## `$description`
107
107
@@ -137,15 +137,15 @@ Rules:
137
137
138
138
A change is considered valid if:
139
139
140
-
- Names follow the naming convention ([Naming](/variables-contract/contract/naming)).
140
+
- Names follow the naming convention ([Naming](naming)).
141
141
- 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)).
143
143
- References use the canonical reference syntax (`{path}`).
144
144
- If `$value` uses modes, mode keys are explicit and shared within a collection.
145
145
- Alias variables do not duplicate raw palette values when a base variable exists.
146
146
- Component variables do not reference base variables directly unless explicitly documented.
147
147
- 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)).
Copy file name to clipboardExpand all lines: docs/examples/figma-export.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This is an example input file shape from a Figma Variables export.
8
8
9
9
- Raw file: `figma-export.json`
10
10
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).
12
12
13
13
## Normalization required
14
14
@@ -20,4 +20,4 @@ Figma exports need normalization before use:
0 commit comments