Skip to content

Commit 4ed833d

Browse files
chore: clean up component analysis docs
- Add content to the components README - Update broken React links - Add status note for POC components in migration analysis docs - Update component status table
1 parent 27db27e commit 4ed833d

File tree

30 files changed

+93
-60
lines changed

30 files changed

+93
-60
lines changed

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/01_status.md

Lines changed: 47 additions & 31 deletions
Large diffs are not rendered by default.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/01_analyze-rendering-and-styling/cursor_prompt.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
<!-- Document content (editable) -->
2525

26-
For the **[COMPONENT_NAME]** component(s), create comprehensive migration documentation in individual markdown files within the `migration-roadmap/` directory of the spectrum-web-components repository, following this exact structure:
26+
For the **[COMPONENT_NAME]** component(s), create comprehensive migration documentation in individual markdown files under CONTRIBUTOR-DOCS: one file per component in `CONTRIBUTOR-DOCS/03_project-planning/03_components/[component-name]/rendering-and-styling-migration-analysis.md`, following this exact structure:
2727

2828
**IMPORTANT**: All files must be created on the original spectrum-web-components branch where the session started.
2929

@@ -253,8 +253,8 @@ Under this heading, add a placeholder section for resources with a bulleted list
253253

254254
## Output format notes
255255

256-
- Create individual markdown files in the migration-roadmap/ directory
257-
- Use component names from spectrum-web-components repository for filenames
256+
- Create one markdown file per component at `CONTRIBUTOR-DOCS/03_project-planning/03_components/[component-name]/rendering-and-styling-migration-analysis.md` (use the component's kebab-case folder name from spectrum-web-components)
257+
- The filename is always `rendering-and-styling-migration-analysis.md`; the folder name is the component name
258258
- Use proper markdown formatting with Level 1 heading for component name
259259
- Ensure all <details> elements are properly closed
260260
- Use consistent table formatting

CONTRIBUTOR-DOCS/03_project-planning/03_components/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88

99
<!-- Generated TOC - DO NOT EDIT -->
1010

11+
<details open>
12+
<summary><strong>In this doc</strong></summary>
13+
14+
- [About this section](#about-this-section)
15+
16+
</details>
17+
1118
<details open>
1219
<summary><strong>Beneath this doc</strong></summary>
1320

@@ -86,4 +93,10 @@
8693

8794
<!-- Document content (editable) -->
8895

89-
(Content to be added)
96+
## About this section
97+
98+
This section provides a **component-centric view** of individual components and how they are affected by multiple workstreams. Use it to understand each component's roadmap and status.
99+
100+
Each component has its own folder (kebab-case). Inside you'll find analysis and planning docs for that component—for example, **rendering-and-styling-migration-analysis.md** for Spectrum 2 CSS-to-SWC migration. The same structure is intended for future peer docs (e.g. a11y analysis, comparative API analysis).
101+
102+
For a workstream-centric view of the same work, see [Workstreams](../02_workstreams/README.md). For how the two views fit together, see the [Project planning overview](../README.md).

CONTRIBUTOR-DOCS/03_project-planning/03_components/action-button/rendering-and-styling-migration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,4 +417,4 @@ The Action Button template is functionally identical between the main branch (le
417417

418418
- [CSS migration](https://github.com/adobe/spectrum-css/pull/2669)
419419
- [Spectrum 2 preview](https://spectrumcss.z13.web.core.windows.net/pr-2352/index.html?path=/docs/components-action-button--docs)
420-
- [React](https://react-spectrum.adobe.com/s2/index.html?path=/docs/actionbutton--docs)
420+
- [React](https://react-spectrum.adobe.com/ActionButton)

CONTRIBUTOR-DOCS/03_project-planning/03_components/action-group/rendering-and-styling-migration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,4 +317,4 @@ All spacing, border radius, and layout changes are handled through CSS custom pr
317317

318318
- [CSS migration](https://github.com/adobe/spectrum-css/pull/2453)
319319
- [Spectrum 2 preview](https://spectrumcss.z13.web.core.windows.net/pr-2352/index.html?path=/docs/components-action-group--docs)
320-
- [React](https://react-spectrum.adobe.com/s2/index.html?path=/docs/actionbuttongroup--docs)
320+
- [React](https://react-spectrum.adobe.com/ActionButtonGroup)

CONTRIBUTOR-DOCS/03_project-planning/03_components/alert-dialog/rendering-and-styling-migration-analysis.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222

2323
<!-- Document content (editable) -->
2424

25+
> **Status:** This analysis is a POC and not final. Full migration analysis for this component is tracked in SWC-1228.
26+
2527
<details>
2628
<summary>CSS selectors</summary>
2729

CONTRIBUTOR-DOCS/03_project-planning/03_components/avatar/rendering-and-styling-migration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,4 +240,4 @@ No significant structural changes between CSS main and spectrum-two branches. Th
240240

241241
- [CSS migration](https://github.com/adobe/spectrum-css/pull/3355)
242242
- [Spectrum 2 preview](https://spectrumcss.z13.web.core.windows.net/pr-2352/index.html?path=/docs/components-avatar--docs)
243-
- [React](https://react-spectrum.adobe.com/s2/index.html?path=/docs/avatar--docs)
243+
- [React](https://react-spectrum.adobe.com/Avatar)

CONTRIBUTOR-DOCS/03_project-planning/03_components/badge/rendering-and-styling-migration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,4 +351,4 @@ No significant structural changes.
351351

352352
- [CSS migration](https://github.com/adobe/spectrum-css/pull/3740)
353353
- [Spectrum 2 preview](https://spectrumcss.z13.web.core.windows.net/pr-2352/index.html?path=/docs/components-badge--docs)
354-
- [React](https://react-spectrum.adobe.com/s2/index.html?path=/docs/badge--docs)
354+
- [React](https://react-spectrum.adobe.com/Badge)

CONTRIBUTOR-DOCS/03_project-planning/03_components/breadcrumbs/rendering-and-styling-migration-analysis.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222

2323
<!-- Document content (editable) -->
2424

25+
> **Status:** This analysis is a POC and not final. Full migration analysis for this component is tracked in SWC-1225.
26+
2527
<details>
2628
<summary>CSS selectors</summary>
2729

CONTRIBUTOR-DOCS/03_project-planning/03_components/button-group/rendering-and-styling-migration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,4 @@ The component structure remains stable across both versions of Spectrum.
157157

158158
- [CSS migration](https://github.com/adobe/spectrum-css/pull/2457)
159159
- [Spectrum 2 preview](https://spectrumcss.z13.web.core.windows.net/pr-2352/index.html?path=/docs/components-button-group--docs)
160-
- [React](https://react-spectrum.adobe.com/s2/index.html?path=/docs/buttongroup--docs)
160+
- [React](https://react-spectrum.adobe.com/ButtonGroup)

0 commit comments

Comments
 (0)