docs(meta): add status pages and rebrand core docs#9
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This pull request adds W3C-style status documentation pages and rebrands the specification from "Variables Contract" to "Variable Design Standard (VDS)". The changes include adding new meta documentation pages, updating all references throughout the codebase to use the new name, and removing outdated recommendation documents.
Changes:
- Added two new meta documentation pages:
status.md(status taxonomy) andstatus-of-this-document.md(W3C-style publication status) - Rebranded all documentation from "Variables Contract" to "Variable Design Standard (VDS)" across 20+ files
- Removed
docs/meta/recommendations.mdfile - Added new Vercel-themed CSS file (though with issues)
- Updated URLs from
variables-contract.vercel.apptovariable-design-standard.vercel.app
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/meta/status.md | New document defining status taxonomy (Draft, Candidate Standard, Stable, Deprecated) |
| docs/meta/status-of-this-document.md | New W3C-style document with publication metadata, issue filing process, and acknowledgments |
| docs/meta/recommendations.md | Removed outdated recommendations document |
| assets/css/vercel-theme.csss | New Vercel-themed CSS (has critical file extension and syntax errors) |
| docmd.config.js | Updated site configuration with new URLs and navigation structure (has path inconsistencies) |
| LICENSE | Updated license text with new specification name and URLs (has schema path inconsistency) |
| README.md | Rebranded to Variable Design Standard with updated DTCG compliance claims |
| docs/meta/change-log.md | Updated version to 0.4.0 with detailed changes (missing rebranding notes) |
| docs/tooling/ecosystem.md | Rebranded all references to Variable Design Standard |
| docs/tooling/ci-cd.md | Updated validation references to VDS |
| docs/tooling/build-pipelines.md | Updated pipeline examples to reference VDS |
| docs/reference/quick-reference.md | Updated quick reference guide with VDS branding |
| docs/reference/glossary.md | Updated terminology definitions and corrected $ref to $extends |
| docs/reference/conformance.md | Updated conformance requirements with VDS naming |
| docs/license.md | Updated license documentation with VDS naming and URLs |
| docs/index.md | Updated homepage with VDS branding and added Meta section |
| docs/governance/* | Updated all governance documentation with VDS references |
| docs/faq.md | Updated FAQ with VDS branding |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Issues, questions, and feedback are welcome via: | ||
|
|
||
| - **GitHub Issues**: [Create an issue](https://github.com/marklearst/variables-contract/issues/new) |
There was a problem hiding this comment.
GitHub repository URL still references the old name "variables-contract". This should be updated to "variable-design-standard" (or "variables-design-standard") to match the rebranding throughout the rest of the documentation.
| - **GitHub Issues**: [Create an issue](https://github.com/marklearst/variables-contract/issues/new) | |
| - **GitHub Issues**: [Create an issue](https://github.com/marklearst/variable-design-standard/issues/new) |
| Schema: https://variables-contract.vercel.app/schema/v1.json | ||
| License Inquiries: https://variables-contract.vercel.app/license | ||
| Canonical Source: https://variable-design-standard.vercel.app | ||
| Schema: https://variable-design-standard.vercel.app/schema/v1.json |
There was a problem hiding this comment.
Schema URL path is inconsistent with the documentation. The LICENSE file references /schema/v1.json, but throughout the documentation (README.md, license.md, etc.) the schema is referenced as /assets/schema/v1.json. This inconsistency could lead to broken links.
| Schema: https://variable-design-standard.vercel.app/schema/v1.json | |
| Schema: https://variable-design-standard.vercel.app/assets/schema/v1.json |
| // basePath is "/variables-contract" for GitHub Pages | ||
| // Vercel deploys from gh-pages branch (same build) and uses rewrites | ||
| const basePath = "/variables-contract"; |
There was a problem hiding this comment.
The basePath and siteUrl are inconsistent. The basePath is still set to "/variables-contract" (old name) while siteUrl has been updated to use "variables-design-standard". The basePath should be updated to "/variables-design-standard" to match the rebranding. Additionally, the comment on line 2 needs to be updated to reflect the new path.
| // basePath is "/variables-contract" for GitHub Pages | |
| // Vercel deploys from gh-pages branch (same build) and uses rewrites | |
| const basePath = "/variables-contract"; | |
| // basePath is "/variables-design-standard" for GitHub Pages | |
| // Vercel deploys from gh-pages branch (same build) and uses rewrites | |
| const basePath = "/variables-design-standard"; |
| Documentation hardening and DTCG 2025.10 compliance improvements. | ||
|
|
||
| ### Features | ||
| ### Changes | ||
|
|
||
| - DTCG 2025.10 format compliance | ||
| - Naming convention rules | ||
| - Reference syntax (curly brace and JSON Pointer) | ||
| - Mode support | ||
| - Group extension (`$ref`) | ||
| - Composite types (Border, Transition, Shadow, Gradient, Typography) | ||
| - Validation requirements | ||
| - Versioning strategy | ||
| - Adapter patterns (Figma, Tokens Studio, Style Dictionary) | ||
| - Role definitions (Designer, Design Engineer, Frontend Developer) | ||
| - Governance workflow | ||
| #### DTCG 2025.10 Compliance Improvements | ||
|
|
||
| ### Documentation | ||
| - **Clarified modes as Variable Design Standard (VDS) extension**: Modes in `$value` objects are NOT part of DTCG 2025.10 specification. This is a Variable Design Standard (VDS) extension inspired by Figma's modes concept. | ||
| - **Updated group extension syntax**: Changed from `$ref` to `$extends` with curly brace syntax (`"$extends": "{group.path}"`) to align with DTCG 2025.10. | ||
| - **Fixed format documentation**: Updated Color, Dimension, and Duration type documentation to show DTCG object format as canonical, with Variable Design Standard (VDS) string shortcuts as convenience formats. | ||
| - **Corrected DTCG feature claims**: Removed "Mode support" from DTCG features list; added modes, string shortcuts, and hex color shorthand to Variable Design Standard (VDS) extensions. | ||
|
|
||
| - Complete specification (51 documentation pages) | ||
| - Adoption guides | ||
| - Governance playbooks | ||
| - Consumption patterns | ||
| - Testing strategies | ||
| - Advanced patterns | ||
| #### Figma Documentation Improvements | ||
|
|
||
| ### Standards elements | ||
| - **Clarified export formats**: Distinguished plugin-generated format from REST API format. | ||
| - **Fixed REST API access claim**: Corrected to "Enterprise plan only" (not Enterprise/Organization). | ||
| - **Clarified export prefixes**: Documented that `@` and `$` prefixes are added by export plugins, not typed in Figma UI. | ||
| - **Added comprehensive Figma links**: Added Designer Resources and Developer Resources sections to LINKS.md. | ||
|
|
||
| - Conformance requirements | ||
| - Glossary | ||
| - Quick reference | ||
| - FAQ | ||
| - References | ||
| #### Documentation Hardening | ||
|
|
||
| - **Version consistency**: Updated all version references from 0.3.7 to 0.4.0. | ||
| - **Fixed incorrect version claims**: Corrected FAQ claim that 1.0.0 is stable. | ||
| - **Updated examples**: Fixed `dtcg-compliant.json` to use strict DTCG object formats. | ||
| - **Improved accuracy**: Ensured all DTCG compliance claims are accurate and verifiable. |
There was a problem hiding this comment.
The change log does not document the rebranding from "Variables Contract" to "Variable Design Standard (VDS)" which is a major change in this PR. The title suggests this is about adding status pages and rebranding core docs, but the change log only mentions DTCG compliance improvements, Figma documentation improvements, and documentation hardening. The rebranding should be explicitly listed as a key change.
| ## UDS Framework | ||
|
|
||
| Variables Contract is part of UMP (UI Mapping Protocol), a larger system for mapping design and development artifacts. | ||
| Variable Design Standard is part of UDS (UI Design Standard), a comprehensive framework for design-to-code governance. | ||
|
|
||
| UMP components: | ||
| UDS components: | ||
|
|
||
| - Variables Contract (this spec) - variables/tokens | ||
| - Component Contract (future) - component mapping | ||
| - Pattern Contract (future) - pattern mapping | ||
| - Variable Design Standard (VDS) - this spec | ||
| - Integrity Design Standard (IDS) - tooling layer (future) | ||
| - Component Design Standard (future) - component mapping | ||
| - Pattern Design Standard (future) - pattern mapping | ||
| - Design-Dev Mapping (future) - artifact relationships | ||
|
|
||
| Variables Contract is the first piece of UMP, focusing on variables. | ||
| Variable Design Standard is the first standard in UDS, focusing on variables. |
There was a problem hiding this comment.
Inconsistent naming in the UDS Framework description. The framework is called "UDS (UI Design Standard)" but the component naming suggests it should be "UDS (UI Design Standards)" (plural). Either the framework name should use the singular "UI Design Standard" or all the component names should use "Standard" (singular). Currently there's a mismatch.
| @@ -0,0 +1,682 @@ | |||
| /** | |||
There was a problem hiding this comment.
File extension is incorrect. The file has a .csss extension (triple 's') instead of .css. This will prevent the CSS file from being loaded or recognized by browsers and build tools.
| } | ||
|
|
||
| .sidebar nav ul ul { | ||
| padding-left: 0 !; |
There was a problem hiding this comment.
Invalid CSS syntax. The rule has padding-left: 0 !; which is missing the important keyword after the exclamation mark. This should be padding-left: 0 !important;
| padding-left: 0 !; | |
| padding-left: 0 !important; |
| defaultMode: "dark", | ||
| enableModeToggle: true, | ||
| positionMode: "top", | ||
| // customCss: ["/assets/css/vercel-theme.css"], |
There was a problem hiding this comment.
The CSS file path is commented out with a double slash, but this file has the wrong extension (.csss instead of .css). If the intention is to enable this custom CSS, the file extension issue must be fixed first, and then this line should be uncommented.
| // customCss: ["/assets/css/vercel-theme.css"], | |
| customCss: ["/assets/css/vercel-theme.css"], |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 4 potential issues.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This PR is being reviewed by Cursor Bugbot
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| // Vercel deploys from gh-pages branch (same build) and uses rewrites | ||
| const basePath = "/variables-contract"; | ||
| const siteUrl = "https://marklearst.github.io/variables-contract"; | ||
| const siteUrl = "https://marklearst.github.io/variables-design-standard"; |
There was a problem hiding this comment.
Inconsistent basePath and siteUrl configuration
Medium Severity
The siteUrl was updated to reference variables-design-standard but basePath still uses /variables-contract. These values are inconsistent - if the GitHub repository was renamed to variables-design-standard, then basePath should also be updated to /variables-design-standard for links and routing to work correctly on GitHub Pages.
| @@ -0,0 +1,682 @@ | |||
| /** | |||
There was a problem hiding this comment.
CSS file has wrong file extension
Low Severity
The CSS theme file has extension .csss (three s's) but docmd.config.js references it as .css. If the custom CSS line is uncommented, the file would fail to load because the referenced path doesn't match the actual filename.
| } | ||
|
|
||
| .sidebar nav ul ul { | ||
| padding-left: 0 !; |
There was a problem hiding this comment.
Invalid CSS syntax with incomplete important declaration
Low Severity
The CSS rule padding-left: 0 !; is syntactically invalid. The ! suggests !important was intended but is incomplete. This would cause the CSS parser to skip this rule entirely.
| } | ||
|
|
||
| a { | ||
| color: var(--link-color) !important; |
There was a problem hiding this comment.
CSS references undefined variable name
Low Severity
The CSS references var(--link-color) but the defined variable is --link (at line 66). This causes the link color to fall back to the browser default since --link-color is undefined.
Note
Major documentation rebrand and metadata additions.
Variable Design Standard (VDS)across LICENSE/README/docs; update canonical URLs and bump version to0.4.0 (Draft)$extends, add JSON Schema references/linkssiteTitle,siteUrl, navigation) to include new Meta section; add Vercel-themed CSS asset (not enabled)Written by Cursor Bugbot for commit 58d5818. This will update automatically on new commits. Configure here.