|
| 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 | + |
1 | 7 | # Spectrum 2 migration roadmap |
2 | 8 |
|
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. |
4 | 45 |
|
5 | 46 | ## Purpose |
6 | 47 |
|
@@ -131,7 +172,7 @@ Set up a Cursor workspace with both repositories: |
131 | 172 |
|
132 | 173 | **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. |
133 | 174 |
|
134 | | -1. **Load the prompt**: Reference `migration-roadmap/cursor_prompt.md` |
| 175 | +1. **Load the prompt**: Reference `cursor_prompt.md` in this step folder |
135 | 176 | 2. **Specify component**: Replace `[COMPONENT_NAME]` with the target component |
136 | 177 | 3. **Branch verification**: Ensure correct branches are checked out: |
137 | 178 | - `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 |
170 | 211 | ### Adding new components |
171 | 212 |
|
172 | 213 | 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` |
174 | 215 | 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 |
176 | 217 |
|
177 | 218 | ## Resources |
178 | 219 |
|
|
0 commit comments