Skip to content

docs: differentiate identical/vague API descriptions #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackgranatowski merged 2 commits into from
Aug 13, 2026
Merged

docs: differentiate identical/vague API descriptions #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4535635
docs: differentiate identical/vague API descriptions
claude Aug 11, 2026
eba3a15
docs: name the -a5 alias in the -tint token descriptions
claude Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions configurator/src/data/api-index.generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"_sync": {
"generatedBy": "configurator/scripts/sync-api.mjs",
"source": "docs/api-index.json",
"tokensHash": "d99951a174ca",
"tokensHash": "db509cdc88a8",
"bundles": [
"full",
"optimal"
Expand Down Expand Up @@ -2571,7 +2571,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Deep action shade for high-contrast contexts.",
"note": "Deep action shade — alias of --sf-color-action-600.",
"value": "var(--sf-color-action-600)",
"aliasOf": "--sf-color-action-600",
"registered": false,
Expand All @@ -2592,7 +2592,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Light action shade for soft accents.",
"note": "Light action shade for soft accents — alias of --sf-color-action-400.",
"value": "var(--sf-color-action-400)",
"aliasOf": "--sf-color-action-400",
"registered": false,
Expand Down Expand Up @@ -2697,7 +2697,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Near-black action shade for maximum contrast on light surfaces.",
"note": "Near-black action shade for maximum contrast on light surfaces — alias of --sf-color-action-950.",
"value": "var(--sf-color-action-950)",
"aliasOf": "--sf-color-action-950",
"registered": false,
Expand All @@ -2718,7 +2718,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Near-white action shade for maximum contrast on dark surfaces.",
"note": "Near-white action shade — alias of --sf-color-action-50.",
"value": "var(--sf-color-action-50)",
"aliasOf": "--sf-color-action-50",
"registered": false,
Expand All @@ -2739,7 +2739,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Near-transparent action tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent action tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-action-a5.",
"value": "var(--sf-color-action-a5)",
"aliasOf": "--sf-color-action-a5",
"registered": false,
Expand All @@ -2760,7 +2760,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Extra-dark action shade.",
"note": "Extra-dark action shade — alias of --sf-color-action-800.",
"value": "var(--sf-color-action-800)",
"aliasOf": "--sf-color-action-800",
"registered": false,
Expand All @@ -2781,7 +2781,7 @@
"category": "Core tokens",
"group": "action",
"description": "Semantic action-color scale derived from --sf-color-action. Covers fills, hover/active states, and tint variants for primary interactive elements.",
"note": "Extra-light action shade.",
"note": "Extra-light action shade — alias of --sf-color-action-200.",
"value": "var(--sf-color-action-200)",
"aliasOf": "--sf-color-action-200",
"registered": false,
Expand Down Expand Up @@ -3285,7 +3285,7 @@
"category": "Core tokens",
"group": "base",
"description": "Semantic base-color scale derived from --sf-color-base. Covers fills, hover/active states, and tint variants for secondary interactive elements.",
"note": "Near-transparent base-surface tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent base-surface tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-base-a5.",
"value": "var(--sf-color-base-a5)",
"aliasOf": "--sf-color-base-a5",
"registered": false,
Expand Down Expand Up @@ -4566,7 +4566,7 @@
"category": "Core tokens",
"group": "neutral",
"description": "Semantic neutral-color scale derived from --sf-color-neutral. Useful for muted UI chrome.",
"note": "Deep neutral shade for high-contrast contexts.",
"note": "Deep neutral shade — alias of --sf-color-neutral-600.",
"value": "var(--sf-color-neutral-600)",
"aliasOf": "--sf-color-neutral-600",
"registered": false,
Expand Down Expand Up @@ -4713,7 +4713,7 @@
"category": "Core tokens",
"group": "neutral",
"description": "Semantic neutral-color scale derived from --sf-color-neutral. Useful for muted UI chrome.",
"note": "Near-white neutral shade.",
"note": "Near-white neutral shade — alias of --sf-color-neutral-50.",
"value": "var(--sf-color-neutral-50)",
"aliasOf": "--sf-color-neutral-50",
"registered": false,
Expand All @@ -4734,7 +4734,7 @@
"category": "Core tokens",
"group": "neutral",
"description": "Semantic neutral-color scale derived from --sf-color-neutral. Useful for muted UI chrome.",
"note": "Near-transparent neutral tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent neutral tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-neutral-a5.",
"value": "var(--sf-color-neutral-a5)",
"aliasOf": "--sf-color-neutral-a5",
"registered": false,
Expand All @@ -4755,7 +4755,7 @@
"category": "Core tokens",
"group": "neutral",
"description": "Semantic neutral-color scale derived from --sf-color-neutral. Useful for muted UI chrome.",
"note": "Extra-dark neutral shade.",
"note": "Extra-dark neutral shade — alias of --sf-color-neutral-800.",
"value": "var(--sf-color-neutral-800)",
"aliasOf": "--sf-color-neutral-800",
"registered": false,
Expand All @@ -4776,7 +4776,7 @@
"category": "Core tokens",
"group": "neutral",
"description": "Semantic neutral-color scale derived from --sf-color-neutral. Useful for muted UI chrome.",
"note": "Extra-light neutral shade.",
"note": "Extra-light neutral shade — alias of --sf-color-neutral-200.",
"value": "var(--sf-color-neutral-200)",
"aliasOf": "--sf-color-neutral-200",
"registered": false,
Expand Down Expand Up @@ -5217,7 +5217,7 @@
"category": "Core tokens",
"group": "primary",
"description": "Semantic primary-color scale derived from --sf-color-primary. Covers fills, hover/active states, and tint variants for the primary palette role.",
"note": "Deep primary shade.",
"note": "Deep primary shade — alias of --sf-color-primary-600.",
"value": "var(--sf-color-primary-600)",
"aliasOf": "--sf-color-primary-600",
"registered": false,
Expand Down Expand Up @@ -5364,7 +5364,7 @@
"category": "Core tokens",
"group": "primary",
"description": "Semantic primary-color scale derived from --sf-color-primary. Covers fills, hover/active states, and tint variants for the primary palette role.",
"note": "Near-white primary shade.",
"note": "Near-white primary shade — alias of --sf-color-primary-50.",
"value": "var(--sf-color-primary-50)",
"aliasOf": "--sf-color-primary-50",
"registered": false,
Expand All @@ -5385,7 +5385,7 @@
"category": "Core tokens",
"group": "primary",
"description": "Semantic primary-color scale derived from --sf-color-primary. Covers fills, hover/active states, and tint variants for the primary palette role.",
"note": "Near-transparent primary tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent primary tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-primary-a5.",
"value": "var(--sf-color-primary-a5)",
"aliasOf": "--sf-color-primary-a5",
"registered": false,
Expand All @@ -5406,7 +5406,7 @@
"category": "Core tokens",
"group": "primary",
"description": "Semantic primary-color scale derived from --sf-color-primary. Covers fills, hover/active states, and tint variants for the primary palette role.",
"note": "Extra-dark primary shade.",
"note": "Extra-dark primary shade — alias of --sf-color-primary-800.",
"value": "var(--sf-color-primary-800)",
"aliasOf": "--sf-color-primary-800",
"registered": false,
Expand All @@ -5427,7 +5427,7 @@
"category": "Core tokens",
"group": "primary",
"description": "Semantic primary-color scale derived from --sf-color-primary. Covers fills, hover/active states, and tint variants for the primary palette role.",
"note": "Extra-light primary shade.",
"note": "Extra-light primary shade — alias of --sf-color-primary-200.",
"value": "var(--sf-color-primary-200)",
"aliasOf": "--sf-color-primary-200",
"registered": false,
Expand Down Expand Up @@ -5889,7 +5889,7 @@
"category": "Core tokens",
"group": "secondary",
"description": "Semantic secondary-color scale derived from --sf-color-secondary.",
"note": "Deep secondary shade.",
"note": "Deep secondary shade — alias of --sf-color-secondary-600.",
"value": "var(--sf-color-secondary-600)",
"aliasOf": "--sf-color-secondary-600",
"registered": false,
Expand Down Expand Up @@ -6036,7 +6036,7 @@
"category": "Core tokens",
"group": "secondary",
"description": "Semantic secondary-color scale derived from --sf-color-secondary.",
"note": "Near-white secondary shade.",
"note": "Near-white secondary shade — alias of --sf-color-secondary-50.",
"value": "var(--sf-color-secondary-50)",
"aliasOf": "--sf-color-secondary-50",
"registered": false,
Expand All @@ -6057,7 +6057,7 @@
"category": "Core tokens",
"group": "secondary",
"description": "Semantic secondary-color scale derived from --sf-color-secondary.",
"note": "Near-transparent secondary tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent secondary tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-secondary-a5.",
"value": "var(--sf-color-secondary-a5)",
"aliasOf": "--sf-color-secondary-a5",
"registered": false,
Expand All @@ -6078,7 +6078,7 @@
"category": "Core tokens",
"group": "secondary",
"description": "Semantic secondary-color scale derived from --sf-color-secondary.",
"note": "Extra-dark secondary shade.",
"note": "Extra-dark secondary shade — alias of --sf-color-secondary-800.",
"value": "var(--sf-color-secondary-800)",
"aliasOf": "--sf-color-secondary-800",
"registered": false,
Expand All @@ -6099,7 +6099,7 @@
"category": "Core tokens",
"group": "secondary",
"description": "Semantic secondary-color scale derived from --sf-color-secondary.",
"note": "Extra-light secondary shade.",
"note": "Extra-light secondary shade — alias of --sf-color-secondary-200.",
"value": "var(--sf-color-secondary-200)",
"aliasOf": "--sf-color-secondary-200",
"registered": false,
Expand Down Expand Up @@ -6771,7 +6771,7 @@
"category": "Core tokens",
"group": "tertiary",
"description": "Semantic tertiary-color scale derived from --sf-color-tertiary.",
"note": "Deep tertiary shade.",
"note": "Deep tertiary shade — alias of --sf-color-tertiary-600.",
"value": "var(--sf-color-tertiary-600)",
"aliasOf": "--sf-color-tertiary-600",
"registered": false,
Expand Down Expand Up @@ -6918,7 +6918,7 @@
"category": "Core tokens",
"group": "tertiary",
"description": "Semantic tertiary-color scale derived from --sf-color-tertiary.",
"note": "Near-white tertiary shade.",
"note": "Near-white tertiary shade — alias of --sf-color-tertiary-50.",
"value": "var(--sf-color-tertiary-50)",
"aliasOf": "--sf-color-tertiary-50",
"registered": false,
Expand All @@ -6939,7 +6939,7 @@
"category": "Core tokens",
"group": "tertiary",
"description": "Semantic tertiary-color scale derived from --sf-color-tertiary.",
"note": "Near-transparent tertiary tint (5% alpha) for hover-state washes and the most subtle backgrounds.",
"note": "Near-transparent tertiary tint (5% alpha) for hover-state washes and the most subtle backgrounds — alias of --sf-color-tertiary-a5.",
"value": "var(--sf-color-tertiary-a5)",
"aliasOf": "--sf-color-tertiary-a5",
"registered": false,
Expand All @@ -6960,7 +6960,7 @@
"category": "Core tokens",
"group": "tertiary",
"description": "Semantic tertiary-color scale derived from --sf-color-tertiary.",
"note": "Extra-dark tertiary shade.",
"note": "Extra-dark tertiary shade — alias of --sf-color-tertiary-800.",
"value": "var(--sf-color-tertiary-800)",
"aliasOf": "--sf-color-tertiary-800",
"registered": false,
Expand All @@ -6981,7 +6981,7 @@
"category": "Core tokens",
"group": "tertiary",
"description": "Semantic tertiary-color scale derived from --sf-color-tertiary.",
"note": "Extra-light tertiary shade.",
"note": "Extra-light tertiary shade — alias of --sf-color-tertiary-200.",
"value": "var(--sf-color-tertiary-200)",
"aliasOf": "--sf-color-tertiary-200",
"registered": false,
Expand Down
Loading