Skip to content

Commit 8053a03

Browse files
docs: move component analysis docs into CONTRIBUTOR-DOCS
1 parent 75fdb40 commit 8053a03

File tree

47 files changed

+1169
-82
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1169
-82
lines changed

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

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

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

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,47 @@
1+
<!-- Generated breadcrumbs - DO NOT EDIT -->
2+
3+
[CONTRIBUTOR-DOCS](../../../../../README.md) / [Project planning](../../../../README.md) / [Workstreams](../../../README.md) / [2nd-gen Component Migration](../../README.md) / Step By Step / Spectrum 2 migration roadmap
4+
5+
<!-- Document title (editable) -->
6+
17
# Spectrum 2 migration roadmap
28

3-
This directory contains comprehensive migration documentation for 2nd generation Spectrum Web Components based on the implementation of Spectrum 2 components that were previously migrated in [Spectrum CSS](https://github.com/adobe/spectrum-css/tree/spectrum-two). It helps engineers understand what needs to be implemented, updated, or aligned between the two systems to guide development of 2nd generation web components.
9+
<!-- Generated TOC - DO NOT EDIT -->
10+
11+
<details open>
12+
<summary><strong>In this doc</strong></summary>
13+
14+
- [Purpose](#purpose)
15+
- [Why we do this analysis](#why-we-do-this-analysis)
16+
- [The bigger picture](#the-bigger-picture)
17+
- [What we analyze](#what-we-analyze)
18+
- [Component specifications](#component-specifications)
19+
- [DOM structure comparison](#dom-structure-comparison)
20+
- [CSS to SWC mapping](#css-to-swc-mapping)
21+
- [Implementation gaps](#implementation-gaps)
22+
- [Documentation structure](#documentation-structure)
23+
- [How to generate documentation](#how-to-generate-documentation)
24+
- [Prerequisites](#prerequisites)
25+
- [Using the cursor prompt](#using-the-cursor-prompt)
26+
- [Quality assurance](#quality-assurance)
27+
- [Common issues to watch for](#common-issues-to-watch-for)
28+
- [Contributing](#contributing)
29+
- [Modifying the cursor prompt](#modifying-the-cursor-prompt)
30+
- [Adding new components](#adding-new-components)
31+
- [Resources](#resources)
32+
33+
</details>
34+
35+
<details open>
36+
<summary><strong>Beneath this doc</strong></summary>
37+
38+
- [Spectrum Migration Documentation Prompt](cursor_prompt.md)
39+
40+
</details>
41+
42+
<!-- Document content (editable) -->
43+
44+
This step contains comprehensive migration documentation for 2nd generation Spectrum Web Components based on the implementation of Spectrum 2 components that were previously migrated in [Spectrum CSS](https://github.com/adobe/spectrum-css/tree/spectrum-two). It helps engineers understand what needs to be implemented, updated, or aligned between the two systems to guide development of 2nd generation web components.
445

546
## Purpose
647

@@ -131,7 +172,7 @@ Set up a Cursor workspace with both repositories:
131172

132173
**Model recommendation**: This type of detailed migration analysis is better handled by slower but more advanced thinking models like Claude or GPT-5, which can provide more thorough analysis and better understand complex component relationships.
133174

134-
1. **Load the prompt**: Reference `migration-roadmap/cursor_prompt.md`
175+
1. **Load the prompt**: Reference `cursor_prompt.md` in this step folder
135176
2. **Specify component**: Replace `[COMPONENT_NAME]` with the target component
136177
3. **Branch verification**: Ensure correct branches are checked out:
137178
- `spectrum-css`: `spectrum-two` for specifications, both `main` and `spectrum-two` for comparisons
@@ -170,9 +211,9 @@ The cursor prompt template (`cursor_prompt.md`) can be modified to improve AI pe
170211
### Adding new components
171212

172213
1. Use the cursor prompt with the target component name
173-
2. Generate the markdown file in `migration-roadmap/[component-name].md`
214+
2. Generate the markdown file in `CONTRIBUTOR-DOCS/03_project-planning/03_components/[component-name]/rendering-and-styling-migration-analysis.md`
174215
3. Review and validate all sections for accuracy
175-
4. Submit a PR to the `2nd-gen-component-analysis` branch
216+
4. Submit a PR
176217

177218
## Resources
178219

migration-roadmap/cursor_prompt.md renamed to 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: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
1+
<!-- Generated breadcrumbs - DO NOT EDIT -->
2+
3+
[CONTRIBUTOR-DOCS](../../../../../README.md) / [Project planning](../../../../README.md) / [Workstreams](../../../README.md) / [2nd-gen Component Migration](../../README.md) / Step By Step / [Spectrum 2 migration roadmap](README.md) / Spectrum Migration Documentation Prompt
4+
5+
<!-- Document title (editable) -->
6+
17
# Spectrum Migration Documentation Prompt
28

9+
<!-- Generated TOC - DO NOT EDIT -->
10+
11+
<details open>
12+
<summary><strong>In this doc</strong></summary>
13+
14+
- [File Organization](#file-organization)
15+
- [Component Documentation Structure](#component-documentation-structure)
16+
- [1. Component Specifications](#1-component-specifications)
17+
- [2. Comparison](#2-comparison)
18+
- [3. Summary of changes](#3-summary-of-changes)
19+
- [4. Resources section](#4-resources-section)
20+
- [Output format notes](#output-format-notes)
21+
22+
</details>
23+
24+
<!-- Document content (editable) -->
25+
326
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:
427

528
**IMPORTANT**: All files must be created on the original spectrum-web-components branch where the session started.
@@ -8,8 +31,8 @@ For the **[COMPONENT_NAME]** component(s), create comprehensive migration docume
831

932
- **One markdown file per component**
1033
- Use the component/package name from the spectrum-web-components repository:
11-
- File path format: `migration-roadmap/[COMPONENT_NAME].md`
12-
- Example: `migration-roadmap/alert-banner.md`, `migration-roadmap/dialog.md`
34+
- File path format: `CONTRIBUTOR-DOCS/03_project-planning/03_components/[component-name]/rendering-and-styling-migration-analysis.md`
35+
- Example: `CONTRIBUTOR-DOCS/03_project-planning/03_components/alert-banner/rendering-and-styling-migration-analysis.md`, `.../dialog/rendering-and-styling-migration-analysis.md`
1336

1437
## Component Documentation Structure
1538

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/01_factor-rendering-out-of-1st-gen-component.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/02_factor-rendering-out-of-1st-gen-component.md

File renamed without changes.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/02_move-base-class-to-2nd-gen-core.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/03_move-base-class-to-2nd-gen-core.md

File renamed without changes.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/03_formalize-spectrum-data-model.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/04_formalize-spectrum-data-model.md

File renamed without changes.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/04_implement-2nd-gen-component.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/05_implement-2nd-gen-component.md

File renamed without changes.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/05_migrate-rendering-and-styles.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/06_migrate-rendering-and-styles.md

File renamed without changes.

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/06_add-stories-for-2nd-gen-component.md renamed to CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/07_add-stories-for-2nd-gen-component.md

File renamed without changes.

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@
1313

1414
- [Status](01_status.md)
1515
- Step By Step
16-
- [Factor rendering out of 1st-gen component](02_step-by-step/01_factor-rendering-out-of-1st-gen-component.md)
17-
- [Move base class to 2nd-gen core](02_step-by-step/02_move-base-class-to-2nd-gen-core.md)
18-
- [Formalize Spectrum data model](02_step-by-step/03_formalize-spectrum-data-model.md)
19-
- [Add 2nd-gen SWC component](02_step-by-step/04_implement-2nd-gen-component.md)
20-
- [Migrate rendering & styles from Spectrum CSS](02_step-by-step/05_migrate-rendering-and-styles.md)
21-
- [Add stories for 2nd-gen component](02_step-by-step/06_add-stories-for-2nd-gen-component.md)
16+
- [Spectrum 2 migration roadmap](02_step-by-step/01_analyze-rendering-and-styling/README.md)
17+
- [Factor rendering out of 1st-gen component](02_step-by-step/02_factor-rendering-out-of-1st-gen-component.md)
18+
- [Move base class to 2nd-gen core](02_step-by-step/03_move-base-class-to-2nd-gen-core.md)
19+
- [Formalize Spectrum data model](02_step-by-step/04_formalize-spectrum-data-model.md)
20+
- [Add 2nd-gen SWC component](02_step-by-step/05_implement-2nd-gen-component.md)
21+
- [Migrate rendering & styles from Spectrum CSS](02_step-by-step/06_migrate-rendering-and-styles.md)
22+
- [Add stories for 2nd-gen component](02_step-by-step/07_add-stories-for-2nd-gen-component.md)
2223

2324
</details>
2425

0 commit comments

Comments
 (0)