Skip to content

Commit 41978ba

Browse files
committed
chore: update documentation and remove obsolete site files
- Updated the .gitignore to include the 'site/' directory to prevent tracking of generated files. - Renamed "Variable Contract" to "Variables Contract" for consistency across documentation. - Removed multiple obsolete HTML files and assets from the site directory to streamline the project structure and improve maintainability.
1 parent debe76b commit 41978ba

File tree

84 files changed

+7
-108709
lines changed

Some content is hidden

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

84 files changed

+7
-108709
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
22
.vercel
33
.env*.local
4+
site/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ See [Implementation Checklist](docs/adoption/implementation-checklist) for compl
139139

140140
### Contract reference
141141

142-
- [Variable Contract](docs/contract/variable-contract) - JSON shape and structure
142+
- [Variables Contract](docs/contract/variable-contract) - JSON shape and structure
143143
- [Groups](docs/contract/groups) - Group structure and extension
144144
- [References](docs/contract/references) - Reference syntax and resolution
145145
- [Modes](docs/contract/modes) - Mode structure and resolution

docs/faq.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Not immediately. Variable Contract provides migration paths from existing format
2525
## What tools do I need?
2626

2727
Any DTCG-compliant tool works. Variable Contract is tool-agnostic. Common tools:
28+
2829
- Figma (authoring)
2930
- Style Dictionary (output generation)
3031
- DTCG validators (validation)
@@ -63,6 +64,7 @@ Use an adapter to normalize tool-specific syntax to Variable Contract format. Se
6364
## How do I validate variables?
6465

6566
Run validation in CI:
67+
6668
1. Validate JSON structure
6769
2. Validate naming convention
6870
3. Validate reference resolution
@@ -111,6 +113,7 @@ See [Conformance](reference/conformance) for conformance requirements and report
111113
## What if I find a bug?
112114

113115
Report issues via GitHub issues. Include:
116+
114117
- Variable Contract version
115118
- Steps to reproduce
116119
- Expected behavior
@@ -119,4 +122,3 @@ Report issues via GitHub issues. Include:
119122
## Can I use Variable Contract with my design system?
120123

121124
Yes. Variable Contract is design-system agnostic. It governs variable structure and governance, not design decisions (values, colors, spacing).
122-

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Public spec for design variables: JSON shape, naming, references, modes, and cha
99
## Start here
1010

1111
- [Why Variables](introduction/why-variables) - Why we call them variables, not design tokens
12-
- [Variable Contract](contract/variable-contract) - JSON shape and structure
13-
- [Variable Governance](governance/overview) - Governance principles and workflow
12+
- [Variables Contract](contract/variable-contract) - JSON shape and structure
13+
- [Variables Governance](governance/overview) - Governance principles and workflow
1414
- [DTCG Alignment](contract/dtcg-alignment) - DTCG 2025.10 compliance
1515
- [Getting Started](adoption/getting-started) - Team adoption guide
1616

0 commit comments

Comments
 (0)