Skip to content

Commit 0e040c0

Browse files
docs: update contributor docs nav (#6149)
- update contributor docs nav - fix a broken link
1 parent bcd9639 commit 0e040c0

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

CONTRIBUTOR-DOCS/02_style-guide/02_typescript/08_component-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
- [Naming conventions](#naming-conventions)
1717
- [Constant prefixes](#constant-prefixes)
1818
- [Type names](#type-names)
19-
- [S1-only suffixing rule](#s1-only-suffixing-rule)
19+
- [Naming rule](#naming-rule)
2020
- [File structure](#file-structure)
2121
- [Section order](#section-order)
2222
- [Section separators](#section-separators)
2323
- [Constant patterns](#constant-patterns)
2424
- [Sizes](#sizes)
2525
- [Variants with S1/S2 split](#variants-with-s1s2-split)
26-
- [Variants without S1/S2 split](#variants-without-s1s2-split)
26+
- [Simple variant arrays](#simple-variant-arrays)
2727
- [Static colors](#static-colors)
2828
- [Non-variant constants](#non-variant-constants)
2929
- [Type derivation patterns](#type-derivation-patterns)

CONTRIBUTOR-DOCS/03_project-planning/01_objectives-and-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- [Continually improve components](#continually-improve-components)
2020
- [Strategy](#strategy)
2121
- [Disruptive vs. non-disruptive change](#disruptive-vs-non-disruptive-change)
22-
- [Side-by-side development of 1st-gen and 2nd-gen](#side-by-side-development-of-1st-gen-and-2nd-gen)
22+
- [Independent development of 1st-gen and 2nd-gen](#independent-development-of-1st-gen-and-2nd-gen)
2323

2424
</details>
2525

CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/01_washing-machine-workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
- [Quick Migration Checklist](#quick-migration-checklist)
1616
- [Relationship to this workstream](#relationship-to-this-workstream)
1717
- [Workflow overview](#workflow-overview)
18-
- [Refactor path (1st-gen required)](#refactor-path-1st-gen-required)
18+
- [Starting from 1st-gen (reference, not dependency)](#starting-from-1st-gen-reference-not-dependency)
1919
- [Core vs SWC: where does code go?](#core-vs-swc-where-does-code-go)
2020
- [Phase 1: Preparation](#phase-1-preparation)
2121
- [What to do](#what-to-do)
@@ -30,7 +30,7 @@
3030
- [Phase 3: API migration](#phase-3-api-migration)
3131
- [What to do](#what-to-do)
3232
- [Property migration scenarios](#property-migration-scenarios)
33-
- [API patterns (statics, warnings, and 1st-gen exports)](#api-patterns-statics-warnings-and-1st-gen-exports)
33+
- [API patterns (statics and warnings)](#api-patterns-statics-and-warnings)
3434
- [What to check](#what-to-check)
3535
- [Common problems and solutions](#common-problems-and-solutions)
3636
- [Quality gate](#quality-gate)
@@ -125,7 +125,7 @@ Use this doc for **what order** to do things and **what to check**; use the link
125125
| **7. Documentation** | **Step 7: Add stories for 2nd-gen component** + JSDoc and usage docs. |
126126
| **8. Review** | (No dedicated step — this guide adds checklist and PR.) |
127127

128-
Follow [Refactor path (1st-gen required)](#refactor-path-1st-gen-required) and the linked step-by-step docs for Steps 2–3. If those steps are **already** done, start **Phase 2** at SWC package setup and the Phase 2 “What to do” list.
128+
Reference to guide to [understand the 1st-gen component structure](../02_step-by-step/02_factor-rendering-out-of-1st-gen-component.md) and the linked step-by-step docs for Steps 2–3. If those steps are **already** done, start **Phase 2** at SWC package setup and the Phase 2 “What to do” list.
129129

130130
---
131131

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
- Step By Step
1616
- [Analyze rendering and styling](02_step-by-step/01_analyze-rendering-and-styling/README.md)
1717
- [Washing machine: migrating an existing 1st-gen component to 2nd-gen](02_step-by-step/01_washing-machine-workflow.md)
18-
- [Factor rendering out of 1st-gen component](02_step-by-step/02_factor-rendering-out-of-1st-gen-component.md)
19-
- [Move base class to 2nd-gen core](02_step-by-step/03_move-base-class-to-2nd-gen-core.md)
18+
- [Understand the 1st-gen component structure](02_step-by-step/02_factor-rendering-out-of-1st-gen-component.md)
19+
- [Create base class in 2nd-gen core](02_step-by-step/03_move-base-class-to-2nd-gen-core.md)
2020
- [Formalize Spectrum data model](02_step-by-step/04_formalize-spectrum-data-model.md)
2121
- [Add 2nd-gen SWC component](02_step-by-step/05_implement-2nd-gen-component.md)
2222
- [Migrate rendering & styles from Spectrum CSS](02_step-by-step/06_migrate-rendering-and-styles.md)

0 commit comments

Comments
 (0)