docs: add consumer migration guides for S2 components#6169
docs: add consumer migration guides for S2 components#6169cdransf wants to merge 6 commits intoswc-1668/poc-componentsfrom
Conversation
|
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
461b6f8 to
d4220ba
Compare
|
This is looking really good! Could we somehow add a "template" / or instructions to the migration guide, so all future components use this format too? |
|
|
||
| | Removed (1st-gen) | Replacement (2nd-gen) | | ||
| | ------------------------------------------- | ------------------------------ | | ||
| | `--mod-badge-height` | `--swc-badge-height` | |
There was a problem hiding this comment.
Not sure if we want to do it in a separate PR or here, but could we document these in the JSDoc of each of the components? This will make sure these properties surface in the API table 😄
Example:
* @cssprop --swc-badge-height - The height of the badge.|
This is looking really good! Could we somehow add a "template" / or instructions to the migration guide, so all future components use this format too? |
74024f7 to
f7b8252
Compare
45cca69 to
40e15d1
Compare
Added a skill and consumer docs for that here 40e15d1 ✨ |
1202c75 to
8dff857
Compare
8dff857 to
ccd3f17
Compare
Description
Adds migration.md files for 7 components in 2nd-gen/packages/swc/components/, following the pattern established
by the avatar migration guide:
and prose container
Each guide includes: installation steps, quick reference table, per-change before/after examples, new features,
and accessibility notes. Follows the same per-component structure proposed in draft #6145.
Motivation and context
Application developers migrating from 1st-gen to 2nd-gen need practical, consumer-focused guidance that goes
beyond internal implementation analysis. These docs cover the day-to-day upgrade path: what to search for, what
to change, and how to validate the result.
Related issue(s)
Author's checklist
Practices
Reviewer's checklist
Manual review test cases
a. Open any migration.md in 2nd-gen/packages/swc/components/[component]/
b. Follow the "Update your code" steps using a real sp-[component] usage as input
c. Expect the before/after examples to produce a working swc-[component] with no regressions
a. Review the icon and status-light guides specifically — these have the most significant removals (name/src
on icon, disabled/accent on status-light)
b. Confirm the guidance is actionable and the "After" examples are valid 2nd-gen markup