Skip to content

Commit 5d6894c

Browse files
louis-preclaude
louis-pre
and
claude
committed
Refactor plan into step_1 and step_2 with before/after trees
- plan/step_1/ — simple 3-way section split - plan/step_2/ — content reorganization per section (guides, api-reference, brand-guides) with before/after trees - Remove old proposed-summaries/ directory Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3c7fda0 commit 5d6894c

5 files changed

Lines changed: 255 additions & 56 deletions

File tree

‎docs-reorganization-plan.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Split the documentation into **3 GitBook site sections**, each backed by its own
1717

1818
> **Requirement:** GitBook Ultimate plan ($249/site/mo) is needed for site sections.
1919
20-
See: [`proposed-summaries/site-structure.md`](proposed-summaries/site-structure.md) for the full proposed sidebar tree.
20+
See: [`plan/`](plan/) for the full proposed sidebar trees (step 1: sectioning, step 2: reorganization).
2121

2222
### Section 1: Guides (main landing space)
2323

proposed-summaries/step-1-site-sections.md renamed to plan/step_1/README.md

File renamed without changes.

‎plan/step_2/api-reference.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Step 2: API Reference Reorganization
2+
3+
## Before (current structure after step 1)
4+
5+
```
6+
API Reference
7+
├── Overview
8+
├── Installation
9+
├── Authentication
10+
├── Pagination
11+
├── Access Codes
12+
│ ├── (CRUD + generate, report constraints)
13+
│ ├── Simulations
14+
│ └── Unmanaged Access Codes
15+
├── Access Control Systems (ACS)
16+
│ ├── Access Groups
17+
│ ├── ACS Users
18+
│ ├── Credentials
19+
│ ├── Encoders (+ simulations)
20+
│ ├── Entrances
21+
│ └── Systems
22+
├── Access Grants
23+
│ └── Unmanaged
24+
├── Access Methods
25+
│ └── Unmanaged
26+
├── Action Attempts
27+
├── Client Sessions
28+
├── Connect Webviews
29+
├── Connected Accounts (+ simulate)
30+
├── Customers
31+
├── Devices (+ simulations, unmanaged)
32+
├── Events
33+
├── Instant Keys
34+
├── Locks (+ simulations)
35+
├── Noise Sensors
36+
│ ├── Simulations
37+
│ └── Noise Thresholds
38+
├── Phones (+ simulations)
39+
├── Spaces
40+
├── Thermostats
41+
│ ├── Daily Programs
42+
│ ├── Schedules
43+
│ └── Simulations
44+
├── User Identities (+ unmanaged)
45+
├── Webhooks
46+
└── Workspaces
47+
```
48+
49+
## After (proposed)
50+
51+
```
52+
API Reference
53+
├── Overview
54+
├── Installation
55+
├── Authentication
56+
├── Pagination
57+
├── Rate Limits
58+
├── Access
59+
│ ├── Access Grants & Identity
60+
│ │ ├── Access Grants (+ unmanaged)
61+
│ │ ├── Access Methods (+ unmanaged)
62+
│ │ ├── User Identities (+ unmanaged)
63+
│ │ └── Instant Keys
64+
│ ├── Smart Locks
65+
│ │ ├── Access Codes (+ simulations, unmanaged)
66+
│ │ └── Locks (+ simulations)
67+
│ └── Access Control Systems
68+
│ ├── Systems
69+
│ ├── Access Groups
70+
│ ├── Users
71+
│ ├── Credentials
72+
│ ├── Encoders (+ simulations)
73+
│ └── Entrances
74+
├── Thermostats
75+
│ └── Thermostats (+ daily programs, schedules, simulations)
76+
├── Noise Sensors
77+
│ └── Noise Sensors (+ noise thresholds, simulations)
78+
├── Connectors & Automations
79+
│ ├── Customers
80+
│ └── Spaces
81+
└── Platform (TBD)
82+
├── Action Attempts
83+
├── Client Sessions
84+
├── Connect Webviews
85+
├── Connected Accounts (+ simulate)
86+
├── Devices (+ simulations, unmanaged)
87+
├── Events
88+
├── Phones (+ simulations)
89+
├── Webhooks
90+
└── Workspaces
91+
```
92+
93+
## Key changes
94+
95+
- Flat namespace list reorganized into **product-type groups** mirroring Guides (Access, Thermostats, Noise Sensors, Connectors & Automations)
96+
- Access endpoints grouped into the same two-tier split: **Access Grants & Identity** and **Smart Locks / ACS**
97+
- Cross-cutting platform resources (Devices, Events, Webhooks, etc.) grouped under **Platform**
98+
- **Rate Limits** added (moved from Guides → Developer Tools)
99+
- Requires codegen changes to `summary.ts` to produce the new grouping

‎plan/step_2/brand-guides.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Step 2: Brand Guides Reorganization
2+
3+
## Before (current structure after step 1)
4+
5+
```
6+
Brand Guides
7+
├── Device and System Integration Guides
8+
│ ├── 4SUITES Locks
9+
│ ├── 33 Lock Devices
10+
│ ├── Akiles Locks
11+
│ ├── ASSA ABLOY Visionline (deep nesting — up to 7 levels)
12+
│ ├── ASSA ABLOY Vingcard
13+
│ ├── Brivo Access
14+
│ ├── Dormakaba Ambiance
15+
│ ├── Dormakaba Community
16+
│ ├── Dormakaba Oracode
17+
│ ├── Honeywell Thermostats
18+
│ ├── igloohome Locks
19+
│ ├── Keynest Key Lockers
20+
│ ├── Latch
21+
│ ├── Lockly Locks
22+
│ ├── Salto KS
23+
│ ├── Salto ProAccess Space
24+
│ ├── Schlage Locks
25+
│ ├── Sensi Thermostats
26+
│ ├── SmartThings Hubs
27+
│ ├── Tedee Locks
28+
│ ├── Ultraloq Locks
29+
│ └── ... (+ more from device-guides/)
30+
├── Sandbox Data (scattered across device-guides/ and developer-tools/)
31+
│ ├── Sandbox August Locks
32+
│ ├── Sandbox ecobee Thermostats
33+
│ ├── Sandbox Minut Sensors
34+
│ └── ... (~40 entries)
35+
└── Device Manufacturer Guidance
36+
├── Building a Seam-Compatible Smart Lock API
37+
└── Creating a Seam-Compatible Intercom API
38+
```
39+
40+
## After (proposed)
41+
42+
```
43+
Brand Guides
44+
├── Smart Locks
45+
│ ├── 4SUITES (setup + sandbox)
46+
│ ├── Akiles (setup + sandbox)
47+
│ ├── August (setup + sandbox)
48+
│ ├── igloohome (setup + sandbox)
49+
│ ├── Kwikset (setup + sandbox)
50+
│ ├── Lockly (setup + sandbox)
51+
│ ├── Nuki (setup + sandbox)
52+
│ ├── Schlage (setup + sandbox)
53+
│ ├── Tedee (setup + sandbox)
54+
│ ├── TTLock (setup + sandbox)
55+
│ ├── Ultraloq (setup)
56+
│ ├── Wyze (setup + sandbox)
57+
│ └── Yale (setup + sandbox)
58+
├── Access Control Systems
59+
│ ├── ASSA ABLOY Visionline (setup + sandbox)
60+
│ ├── ASSA ABLOY Vingcard (setup + sandbox)
61+
│ ├── Brivo Access (setup + sandbox)
62+
│ ├── Dormakaba Ambiance (setup + sandbox)
63+
│ ├── Dormakaba Community (setup + sandbox)
64+
│ ├── Latch (setup + sandbox)
65+
│ ├── Salto KS (setup + sandbox)
66+
│ ├── Salto ProAccess Space (setup + sandbox)
67+
│ └── ...
68+
├── Thermostats
69+
│ ├── ecobee (setup + sandbox)
70+
│ ├── Google Nest (setup + sandbox)
71+
│ ├── Honeywell Resideo (setup + sandbox)
72+
│ ├── Sensi (setup + sandbox)
73+
│ └── SmartThings (setup + sandbox)
74+
├── Other Devices & Systems
75+
│ ├── 2N Intercoms (setup + sandbox)
76+
│ ├── ControlByWeb Relays (sandbox)
77+
│ ├── Dormakaba Oracode (setup + sandbox)
78+
│ ├── Keynest Key Lockers (setup + sandbox)
79+
│ ├── Minut Sensors (sandbox)
80+
│ ├── NoiseAware Sensors (sandbox)
81+
│ └── ...
82+
└── Device Manufacturer Guidance
83+
├── Building a Seam-Compatible Smart Lock API
84+
└── Creating a Seam-Compatible Intercom API
85+
```
86+
87+
## Key changes
88+
89+
- Brands organized by **device category** (Smart Locks, ACS, Thermostats, Other) instead of flat alphabetical list
90+
- **Sandbox data consolidated alongside each brand** instead of in a separate section
91+
- Content from `device-guides/` and `device-and-system-integration-guides/` merged into one structure
92+
- Deep nesting reduced (ASSA ABLOY Visionline goes from 7 levels to max 4)

proposed-summaries/step-2-site-structure.md renamed to plan/step_2/guides.md

Lines changed: 63 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,58 @@
1-
# Proposed Site Structure
1+
# Step 2: Guides Reorganization
22

3-
## Guides
3+
## Before (current structure after step 1)
4+
5+
```
6+
Guides
7+
├── Seam Documentation
8+
├── Quick Start
9+
├── Go Live
10+
├── Core Concepts
11+
│ ├── Overview
12+
│ ├── Seam Console
13+
│ ├── Workspaces
14+
│ ├── Authentication
15+
│ ├── Connect Webviews
16+
│ ├── Devices
17+
│ ├── Providers
18+
│ ├── Connected Accounts
19+
│ ├── Mapping Resources
20+
│ └── Action Attempts
21+
├── Capability Guides
22+
│ ├── Device and System Capabilities
23+
│ ├── Smart Locks
24+
│ │ ├── Locking and Unlocking
25+
│ │ └── Access Codes (create, retrieve, modify, delete, lifecycle, ...)
26+
│ ├── Access Control Systems
27+
│ │ ├── Quick Starts (PIN, Key Card, Mobile Key)
28+
│ │ ├── Connect an ACS to Seam
29+
│ │ ├── Managing ACS Users
30+
│ │ ├── Managing Credentials
31+
│ │ ├── Card Encoders & Scanners
32+
│ │ └── Troubleshooting
33+
│ ├── Mobile Access
34+
│ ├── Access Grants
35+
│ ├── Instant Keys
36+
│ ├── Thermostats
37+
│ ├── Noise Sensors
38+
│ ├── Seam Bridge
39+
│ ├── Customer Portals
40+
│ └── Reservation Automations
41+
├── UI Components
42+
│ ├── Seam Components (React, Angular, Vue)
43+
│ └── Seam Mobile Components (iOS)
44+
├── Developer Tools
45+
│ ├── Webhooks
46+
│ ├── Seam CLI
47+
│ ├── Seam MCP Server
48+
│ ├── Rate Limits
49+
│ ├── Mobile SDKs (Android, iOS)
50+
│ └── Sandbox Devices and Systems (40 entries)
51+
└── Industry Guides
52+
└── Hospitality
53+
```
54+
55+
## After (proposed)
456

557
```
658
Guides
@@ -61,57 +113,13 @@ Guides
61113
└── Hospitality
62114
```
63115

64-
## API Reference
65-
66-
```
67-
API Reference
68-
├── Overview
69-
├── Installation
70-
├── Authentication
71-
├── Pagination
72-
├── Rate Limits
73-
├── Access
74-
│ ├── Access Grants & Identity
75-
│ │ ├── Access Grants (+ unmanaged)
76-
│ │ ├── Access Methods (+ unmanaged)
77-
│ │ ├── User Identities (+ unmanaged)
78-
│ │ └── Instant Keys
79-
│ ├── Smart Locks
80-
│ │ ├── Access Codes (+ simulations, unmanaged)
81-
│ │ └── Locks (+ simulations)
82-
│ └── Access Control Systems
83-
│ ├── Systems
84-
│ ├── Access Groups
85-
│ ├── Users
86-
│ ├── Credentials
87-
│ ├── Encoders (+ simulations)
88-
│ └── Entrances
89-
├── Thermostats
90-
│ └── Thermostats (+ daily programs, schedules, simulations)
91-
├── Noise Sensors
92-
│ └── Noise Sensors (+ noise thresholds, simulations)
93-
├── Connectors & Automations
94-
│ ├── Customers
95-
│ └── Spaces
96-
└── Platform (TBD)
97-
├── Action Attempts
98-
├── Client Sessions
99-
├── Connect Webviews
100-
├── Connected Accounts (+ simulate)
101-
├── Devices (+ simulations, unmanaged)
102-
├── Events
103-
├── Phones (+ simulations)
104-
├── Webhooks
105-
└── Workspaces
106-
```
107-
108-
## Integrations
116+
## Key changes
109117

110-
```
111-
Integrations
112-
├── Smart Locks (each with setup + sandbox)
113-
├── Access Control Systems (each with setup + sandbox)
114-
├── Thermostats (each with setup + sandbox)
115-
├── Other Devices & Systems
116-
└── Device Manufacturer Guidance
117-
```
118+
- **Capability Guides** is replaced by product-type sections: **Access**, **Thermostats**, **Noise Sensors**
119+
- Access is split into two tiers: **Access Grants & Identity** (high-level) and **Smart Locks / ACS** (low-level)
120+
- Mobile Access moves under ACS (low-level device credentials)
121+
- User Identities moves up to Access Grants & Identity (high-level)
122+
- Seam Bridge moves under ACS
123+
- UI Components moves under Developer Tools
124+
- Rate Limits and Sandbox data removed (Rate Limits → API Reference, Sandbox → Brand Guides)
125+
- Connectors & Automations becomes its own section (cross-product)

0 commit comments

Comments
 (0)