Skip to content

Commit c9a8d6c

Browse files
committed
docs(schema): move schema to assets and update docs
1 parent b14da0c commit c9a8d6c

File tree

3 files changed

+11
-490
lines changed

3 files changed

+11
-490
lines changed

assets/schema/v1.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "https://json-schema.org/draft-07/schema",
3-
"$id": "https://variables-contract.vercel.app/assets/schema/v1.json",
4-
"title": "Variables Contract Schema v1",
5-
"description": "JSON Schema for validating Variables Contract compliant design variable files. DTCG 2025.10 aligned.",
3+
"$id": "https://variable-design-standard.vercel.app/assets/schema/v1.json",
4+
"title": "Variable Design Standard (VDS) JSON Schema v1",
5+
"description": "JSON Schema for validating Variable Design Standard (VDS) compliant design variable files. DTCG 2025.10 aligned.",
66
"type": "object",
77
"additionalProperties": {
88
"$ref": "#/$defs/groupOrVariable"

docs/schema/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
title: Schema
33
---
44

5-
# Variables Contract JSON Schema
5+
# Variable Design Standard (VDS) JSON Schema
66

7-
The Variables Contract provides a JSON Schema for validating design variable files. This schema enforces DTCG 2025.10 alignment and Variables Contract conformance requirements.
7+
The Variable Design Standard (VDS) provides a JSON Schema for validating design variable files. This schema enforces DTCG 2025.10 alignment and Variable Design Standard (VDS) conformance requirements.
88

99
## Schema URL
1010

1111
```
12-
https://variables-contract.vercel.app/assets/schema/v1.json
12+
https://variable-design-standard.vercel.app/assets/schema/v1.json
1313
```
1414

1515
## Usage
1616

17-
Add the `$schema` property to your Variables Contract JSON files to enable validation:
17+
Add the `$schema` property to your Variable Design Standard (VDS) JSON files to enable validation:
1818

1919
```json
2020
{
21-
"$schema": "https://variables-contract.vercel.app/assets/schema/v1.json",
21+
"$schema": "https://variable-design-standard.vercel.app/assets/schema/v1.json",
2222
"color": {
2323
"primary": {
2424
"$type": "color",
@@ -177,7 +177,7 @@ The JSON Schema validates structure but cannot check:
177177
- **Reference resolution** - Whether referenced variables exist
178178
- **Circular references** - Cycles in reference chains
179179
- **Mode consistency** - Whether all variables in a collection use the same modes
180-
- **Naming conventions** - Variables Contract naming rules
180+
- **Naming conventions** - Variable Design Standard (VDS) naming rules
181181

182182
Use additional validation tooling for complete conformance checking.
183183

@@ -186,8 +186,8 @@ Use additional validation tooling for complete conformance checking.
186186
The schema is available at:
187187

188188
- **URL:** [/assets/schema/v1.json](/assets/schema/v1.json)
189-
- **Raw:** [GitHub](https://github.com/marklearst/variables-contract/blob/main/docs/schema/v1.json)
189+
- **Raw:** [GitHub](https://github.com/marklearst/variables-contract/blob/main/assets/schema/v1.json)
190190

191191
## Conformance
192192

193-
Using this schema for validation is one component of Variables Contract conformance. See [Conformance](/reference/conformance) for complete requirements.
193+
Using this schema for validation is one component of Variable Design Standard (VDS) conformance. See [Conformance](/reference/conformance) for complete requirements.

0 commit comments

Comments
 (0)