Skip to content

Commit 5a4b9a1

Browse files
committed
Prioritize P3 API docs in ROADMAP and TODO
Mark Phase 3 API documentation as the current priority and blocking work for Phase 4 and spectre-init Phase 6. Update ROADMAP.md and TODO.md to clarify that README examples are missing, add explicit unblock lists (spectre-shell-router, spectre-init, spectre-shell), and refine the recommended execution order with completed items, phase labels, and phrasing improvements. Mostly editorial/organizational updates to emphasize that Phase 4 cannot start until P3 docs are finished.
1 parent f97a2c2 commit 5a4b9a1

2 files changed

Lines changed: 32 additions & 19 deletions

File tree

ROADMAP.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,17 @@ Design-only until a concrete application need is proven. Evaluate alongside
125125

126126
---
127127

128-
### P3: API Documentation — BLOCKING Phase 4
128+
### P3: API Documentation — CURRENT PRIORITY — BLOCKING Phase 4 + spectre-init Phase 6
129129

130-
These APIs shipped in v1.1.0 but README examples are missing or incomplete.
131-
This section must be closed before any Phase 4 work ships. `spectre-init`
132-
templates cannot safely scaffold these patterns without documented examples.
130+
These APIs shipped in v1.1.0 but README examples are missing. This is the current
131+
work item. Nothing in Phase 4 starts until these are written. `spectre-init` Phase 6
132+
templates cannot scaffold these patterns without copy-able examples to reference.
133+
134+
**Unblocks:**
135+
136+
- `spectre-shell-router` Phase 4 (error routes, history helpers)
137+
- `spectre-init` Phase 6 (lifecycle, title, loading state, plugin templates)
138+
- `spectre-shell` P2.5 release (can ship once templates have stable examples)
133139

134140
#### `meta` + `afterNavigate` — document title and a11y pattern
135141

@@ -200,13 +206,14 @@ Support child routes rendered inside parent outlet elements.
200206

201207
## Recommended Execution Order
202208

203-
1. Navigation subscription API — unblocks `spectre-shell-signals` integration
204-
2. Navigating state hooks — unblocks loading UI in `spectre-ui`
205-
3. Per-route metadata — unblocks title management and analytics
206-
4. `afterNavigate` hook — completes the navigation lifecycle surface
207-
5. Error routes — closes the silent-failure gap for production apps
208-
6. Navigation history helpers — ergonomic, low-risk, additive
209-
7. Nested routing — only when a concrete app need is confirmed
209+
1. ~~Navigation subscription API~~
210+
2. ~~Navigating state hooks~~
211+
3. ~~Per-route metadata~~
212+
4. ~~`afterNavigate` hook~~
213+
5. **Phase 3 P3 API docs** ← current (meta, afterNavigate, onNavigationStart/End, subscribe pattern)
214+
6. Error routes — closes the silent-failure gap; Phase 4 P0 (starts after P3 docs close)
215+
7. Navigation history helpers — ergonomic, low-risk, additive; Phase 4 P1
216+
8. Nested routing — only when a concrete app need is confirmed
210217

211218
---
212219

TODO.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,17 @@ Close P3 docs before starting any Phase 4 work.
9393
- [ ] **Nested routing proposal** (planning doc only; implement only when a concrete need is proven)
9494
- Evaluate alongside `spectre-ui-astro` layout patterns before committing to an API
9595

96-
### P3: Phase 3 API Documentation — NEXT — Blocking Phase 4 and spectre-init
96+
### P3: Phase 3 API Documentation — CURRENT PRIORITY — Blocking Phase 4 + spectre-init Phase 6
9797

98-
These APIs shipped in v1.1.0 but README examples are missing or incomplete.
99-
Do these before any Phase 4 work. spectre-init templates cannot safely scaffold
100-
these patterns without documented examples to copy.
98+
These APIs shipped in v1.1.0 but README examples are missing. Do all four before
99+
starting any Phase 4 work. spectre-init Phase 6 templates cannot scaffold these
100+
patterns without documented examples to copy.
101+
102+
Unblocks when complete:
103+
104+
- This repo: Phase 4 can start (error routes, history helpers)
105+
- `spectre-init`: Phase 6 template modernization (lifecycle, title, loading, plugin)
106+
- `spectre-shell`: P2.5 release readiness (templates need stable examples first)
101107

102108
- [ ] **Document `meta: { title: string }` pattern in README**
103109
- Files: `README.md`
@@ -180,10 +186,10 @@ handling, navigation history helpers, and nested outlet support when a concrete
180186
2. ~~Navigating state hooks~~
181187
3. ~~Per-route metadata~~
182188
4. ~~`afterNavigate` hook~~
183-
5. **Phase 3 API docs** ← current (meta, afterNavigate, onNavigationStart/End, subscribe pattern)
184-
6. Error routes (closes the silent-failure gap; Phase 4 P0)
185-
7. Navigation history helpers (back/forward/replace; Phase 4 P1)
186-
8. Nested routing (only when a concrete application need is proven)
189+
5. **Phase 3 P3 API docs** ← current (meta, afterNavigate, onNavigationStart/End, subscribe pattern)
190+
6. Error routes Phase 4 P0 (starts after P3 docs close)
191+
7. Navigation history helpers Phase 4 P1 (back/forward/replace)
192+
8. Nested routing only when a concrete application need is proven
187193

188194
---
189195

0 commit comments

Comments
 (0)