Skip to content

Commit 73c97a3

Browse files
committed
docs: minor edits to contributor docs
1 parent 9dfc9d6 commit 73c97a3

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CONTRIBUTOR-DOCS/01_objectives-and-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Meanwhile, most of the **accessibility improvements** and general **component im
9393

9494
### Side-by-side development of 1st-gen and 2nd-gen
9595

96-
We have decided to work on 1st-gen and 2nd-gen side-by-side, in the same repository. This gives us two important advantages: **isolation** and **colocation**.
96+
We have decided to work on 1st-gen and 2nd-gen side-by-sidein the same repository, but in separate workspaces. This gives us two important advantages: **isolation** and **colocation**.
9797

9898
**Isolation** of 1st-gen and 2nd-gen in separate workspaces lets us build 2nd-gen iteratively from the ground up, leaving behind as much structural and technical debt as possible, without needing to worry about breaking 1st-gen. Disruptive changes are confined to the `second-gen` workspace, while the 1st-gen project continues working essentially "as-is."
9999

CONTRIBUTOR-DOCS/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
- [About Spectrum Web Components](#about-spectrum-web-components)
1111
- [About the 1st-gen-to-2nd-gen transition](#about-the-1st-gen-to-2nd-gen-transition)
12-
- [About these contributor docs](#about-these-contributor-docs)
12+
- [About these docs](#about-these-docs)
1313

1414
</details>
1515

@@ -66,9 +66,11 @@ Reflecting the side-by-side strategy, the repository is organized into two top-l
6666

6767
During this transition, depending on what you're trying to accomplish, you may end up working in `first-gen`, `second-gen`, or both. If you have any questions, please ask—we're happy to help.
6868

69-
## About these contributor docs
69+
## About these docs
7070

71-
These contributor docs are organized into several sections to help you find the information you need:
71+
These docs contain essential information about the SWC project for both maintainers (members of the core team) and contributors from outside the core team.
72+
73+
The docs are organized into several sections to help you find the information you need:
7274

7375
**[Objectives and Strategy](./01_objectives-and-strategy.md)** - Strategic context for the 1st-gen-to-2nd-gen transition, including our goals and approach. This explains why we're making this transition and how we're managing the work to advance multiple objectives in parallel while continuing to deliver value to customers.
7476

0 commit comments

Comments
 (0)