design-system-documentation-schema/spec/examples/minimal/style.json at main · somerandomdude/design-system-documentation-schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "kind": "style",
  "identifier": "spacing",
  "name": "Spacing",
  "metadata": [
    {
      "kind": "description",
      "value": "The spatial system governing layout rhythm and component density."
    },
    {
      "kind": "status",
      "status": "stable"
    }
  ],
  "documentBlocks": [
    {
      "kind": "principles",
      "items": [
        {
          "title": "Use the scale",
          "description": "Always pick a value from the spacing scale. Avoid arbitrary pixel values."
        }
      ],
      "agents": {
        "intent": "State the foundational beliefs governing this style.",
        "keywords": [
          "principles",
          "guidelines"
        ]
      }
    }
  ],
  "agents": {
    "intent": "Document spacing scale tokens and enforce their consistent application across layout, components, and typography.",
    "constraints": [
      {
        "rule": "Do not substitute spacing tokens with typography or icon-size tokens.",
        "level": "must-not"
      },
      {
        "rule": "Always use the next scale step up or down rather than custom values.",
        "level": "should"
      }
    ],
    "disambiguation": [
      {
        "entity": "typography style",
        "distinction": "Spacing governs whitespace and layout gaps; typography governs type size, weight, and line height."
      }
    ],
    "keywords": [
      "spacing",
      "scale",
      "gap",
      "padding",
      "margin",
      "whitespace",
      "layout",
      "density"
    ]
  }
}