docs: Update Token Migration guide to use v4 tokens#3791
Open
RayRedGoose wants to merge 9 commits intoWorkday:prerelease/majorfrom
Open
docs: Update Token Migration guide to use v4 tokens#3791RayRedGoose wants to merge 9 commits intoWorkday:prerelease/majorfrom
RayRedGoose wants to merge 9 commits intoWorkday:prerelease/majorfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Canvas Kit token migration documentation to reflect @workday/canvas-tokens-web@4.0.0, replacing older v3 references with v4 token names and updated migration guidance.
Changes:
- Updates the migration overview and examples to use v4 system/brand tokens (e.g.,
system.padding.*,system.color.surface.*,brand.primary600). - Expands mapping tables (space/shape/typography/colors) with v4-specific columns and recommendations.
- Adds a caution note clarifying the existing codemod only supports v2 → v3 (no v4 codemod yet).
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/docs/mdx/tokens/TokenMigrationOverview.mdx | Switches guide framing and examples to v4 tokens; updates narrative around v4 design refresh. |
| modules/docs/mdx/tokens/TokenMigrationMappingSystem.mdx | Updates system mapping tables to include v4 size/gap/padding tokens and revised examples. |
| modules/docs/mdx/tokens/TokenMigrationMappingColors.mdx | Reworks color mapping tables and usage guidance toward v4 surface/fg/border patterns and updated brand scale naming. |
| modules/docs/mdx/tokens/TokenMigrationInstall.mdx | Updates install/setup guidance and examples to v4 token usage patterns. |
| modules/docs/mdx/tokens/TokenMigrationFinal.mdx | Updates “complete migration” examples to v4 system/brand tokens. |
| modules/docs/mdx/tokens/TokenMigrationCodemod.mdx | Adds an explicit note that the codemod does not support migrating to v4 tokens. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Workday/canvas-kit
|
||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
ISSUE3722-token-migration-guide
|
| Run status |
|
| Run duration | 02m 15s |
| Commit |
|
| Committer | Raisa Primerova |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
15
|
Skipped
|
0
|
Passing
|
790
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
19.43%
|
|
|---|---|
|
Untested elements
|
1524
|
|
Tested elements
|
365
|
Accessibility
99.38%
|
|
|---|---|
|
Failed rules
|
5 critical
5 serious
0 moderate
2 minor
|
|
Failed elements
|
67
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| <StorybookInformationHighlight | ||
| variant="caution" | ||
| title="v2 -> v3 Codemod" | ||
| description="This codemod automates the migration of old Canvas Kit React tokens or @workday/canvas-tokens-web v2 tokens to the new v3 token format. Note: There is currently no codemod available for migration to v4 tokens." |
Contributor
There was a problem hiding this comment.
Did you want to add this to master instead of prerelease/major? I'd assume in major we'd have a token code mod no?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes: #3722
Update token migration guide to use v4 tokens in tables and examples.
Release Category
Documentation
Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
Areas for Feedback? (optional)
Testing Manually
Screenshots or GIFs (if applicable)
Thank You Gif (optional)