Skip to content

Commit 6c9feab

Browse files
committed
docs: update internal links for consistency and navigation
- Updated internal links across various documentation files to use absolute paths for improved accessibility. - Ensured that references to the Naming, Change Control, and Adapters sections are correctly linked. - Enhanced clarity in the documentation by maintaining consistent link formatting throughout.
1 parent c78ac2b commit 6c9feab

File tree

24 files changed

+52
-53
lines changed

24 files changed

+52
-53
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](../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](../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](../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/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](../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](../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](../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](../contract/anatomy) for details.
235+
See [Anatomy](/contract/anatomy) for details.
236236

237237
### Artifacts that change
238238

docs/contract/dtcg-alignment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ DTCG 2025.10 defines:
2626
Variable Contract adds a governance layer on top of DTCG format:
2727

2828
- 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))
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/variable-contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ 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](../adapters) for adapter patterns and implementations.
21+
See [Adapters](/adapters) for adapter patterns and implementations.
2222

2323
## Adapter pipeline
2424

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

160-
See [Conformance](../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/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](../../adapters/figma) to normalize it into the canonical contract format defined in [Variable 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](../adapters/figma) for complete normalization steps.
23+
See [Figma Adapter](/adapters/figma) for complete normalization steps.

docs/governance/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Use this checklist when you're adding or changing a variable.
1616

1717
1. Read:
1818
- [Variable Governance](overview)
19-
- [Naming](../contract/naming)
20-
- [Tokens Studio](../adapters/tokens-studio)
19+
- [Naming](/contract/naming)
20+
- [Tokens Studio](/adapters/tokens-studio)
2121
- [Change Control](change-control)
2222
2. Identify which variable category you are working in:
2323
- base

docs/governance/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ Governance is what keeps variable changes boring: reviewed, versioned, and safe
4747

4848
## Reference
4949

50-
- [Naming](../contract/naming)
51-
- [Tokens Studio](../adapters/tokens-studio)
50+
- [Naming](/contract/naming)
51+
- [Tokens Studio](/adapters/tokens-studio)
5252
- [Accessibility](accessibility)

docs/governance/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Governance is how you keep a token change from turning into a cleanup project ac
88

99
The rules here treat variable names and references like an API: changes are reviewed, and breaking changes are called out.
1010

11-
The contract rules (schema and validation expectations) live in [Variable Contract](../contract/variable-contract).
11+
The contract rules (schema and validation expectations) live in [Variable Contract](/contract/variable-contract).
1212

1313
## Principles
1414

docs/governance/roles/design-engineer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If a candidate cannot demonstrate these skills, they are not ready for this role
6060

6161
### Contract owner responsibilities
6262

63-
- Own the Variable Contract ([Variable Contract](../../contract/variable-contract)).
63+
- Own the Variable Contract ([Variable Contract](/contract/variable-contract)).
6464
- Approve all variable changes before they enter version control.
6565
- Maintain naming rules and category boundaries (base, alias, component).
6666
- Review variable changes for contract correctness, references, and mode strategy.

docs/governance/roles/designer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Design Engineer reviews and approves all variable changes before they enter the
1414

1515
## Responsibilities
1616

17-
- Create variables in Figma following naming convention (see [Naming](../../contract/naming)).
17+
- Create variables in Figma following naming convention (see [Naming](/contract/naming)).
1818
- Define semantic intent for variables (what they represent, not just values).
1919
- Define mode values (light/dark, mobile/desktop) when needed.
20-
- Use variables in Figma components (see [Component Variables](../../design/component-variables)).
21-
- Export variables for normalization (see [Figma Workflow](../../design/figma-workflow)).
20+
- Use variables in Figma components (see [Component Variables](/design/component-variables)).
21+
- Export variables for normalization (see [Figma Workflow](/design/figma-workflow)).
2222
- Submit variable changes for review by Design Engineer.
2323

2424
## Boundaries

0 commit comments

Comments
 (0)