Sample Taxonomy

sample-taxonomy.json5

[
  {
    "id": "taxonomy-random-id-1",
    "title": "Sample taxonomy",
    "description": "This is a sample taxonomy for demonstration purposes.",
    // Optional: Link to external documentation for further reference, including visuals and usage guidelines.
    "documentationUrl": "https://example.com/sample-taxonomy-docs",
    // Scopes the taxonomy to specific token types for better usability and clarity.
    "tokenTypes": [
      // Reference token types by url? https://opensource.adobe.com/spectrum-tokens/schemas/token-types/color.json
      // Would be nice to have a shortcut for "all"?
      "TokenTypeA",
      "TokenTypeB"
    ],
    // Scopes the taxonomy to specific token tiers, as only certain tiers may use this taxonomy.
    "tokenTiers": [
      "Semantic" // Much discussion could be had on these, but I'd default to the standards of Primitive, Semantic, and Component.
    ],
    "terms": [
      {
        "id": "term-random-id-1",
        "name": "Term One",
        "description": "Description for Term One.",
        // Optional: Link to anchors/specific docs for the term.
        "documentationUrl": "https://example.com/sample-taxonomy-docs#term-one"
      },
      {
        "id": "term-random-id-2",
        "name": "Term Two",
        "description": "Description for Term Two.",
        "documentationUrl": "https://example.com/sample-taxonomy-docs#term-two"
      }
    ]
  }
  // Other taxonomies and terms...
]

sample-taxonomy.yaml

- id: taxonomy-random-id-1
  title: Sample taxonomy
  description: This is a sample taxonomy for demonstration purposes.
  # Optional: Link to external documentation for further reference, including visuals and usage guidelines.
  documentationUrl: https://example.com/sample-taxonomy-docs
  # Scopes the taxonomy to specific token types for better usability and clarity.
  tokenTypes:
    # Reference token types by url? https://opensource.adobe.com/spectrum-tokens/schemas/token-types/color.json
    # Would be nice to have a shortcut for "all"?
    - TokenTypeA
    - TokenTypeB
  # Scopes the taxonomy to specific token tiers, as only certain tiers may use this taxonomy.
  tokenTiers:
    - Semantic # Much discussion could be had on these, but I'd default to the standards of Primitive, Semantic, and Component.
  terms:
    - id: term-random-id-1
      name: Term One
      description: Description for Term One.
      # Optional: Link to anchors/specific docs for the term.
      documentationUrl: https://example.com/sample-taxonomy-docs#term-one
    - id: term-random-id-2
      name: Term Two
      description: Description for Term Two.
      documentationUrl: https://example.com/sample-taxonomy-docs#term-two
    # Other taxonomies and terms...