Skip to content

Commit 29559cd

Browse files
louis-preclaude
andcommitted
Add step 2 README with TODOs for get started, core concepts, and more
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 749b47c commit 29559cd

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

plan/step_2/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Step 2: Reorganize Content Within Each Section
2+
3+
After step 1 splits the docs into 3 GitBook site sections, step 2 reorganizes the sidebar structure within each section.
4+
5+
See the before/after trees for each section:
6+
- [Guides](guides.md)
7+
- [API Reference](api-reference.md)
8+
- [Brand Guides](brand-guides.md)
9+
10+
## TODOs
11+
12+
- [ ] **Get Started section** — How should Quick Start and Go Live be organized? Should they remain top-level, be grouped under a "Get Started" section, or be split per product (e.g., "Get started with Access", "Get started with Thermostats")?
13+
- [ ] **Core Concepts section** — Review which concepts are still relevant as top-level items. Some may fold into product sections (e.g., Devices into Access, Connect Webviews into a setup/onboarding flow). Others may be too granular for their current placement (e.g., custom metadata filtering pages).
14+
- [ ] **Connectors & Automations placement** — Cross-product section, but location TBD.
15+
- [ ] **Seam Bridge placement** — Currently under ACS, may move closer to Connected Accounts.
16+
- [ ] **SDKs and UI component libraries** — Define the content split between Guides (setup, usage, tutorials) and API Reference (API surface, parameters, methods).
17+
- [ ] **API Reference product grouping** — Requires codegen changes to `summary.ts` to produce the new grouping instead of flat namespace list.
18+
- [ ] **Platform section in API Reference** — Review which resources belong here vs under a product group.

0 commit comments

Comments
 (0)