Files
unraid-docker-manager/.planning/ROADMAP.md
T
Lucas Berger c122803fad docs(10): create phase plan for workflow modularization
Phase 10: Workflow Modularization
- 4 plan(s) in 3 wave(s)
- Wave 1: Orphan cleanup (1 plan)
- Wave 2: Sub-workflow extraction (2 plans parallel)
- Wave 3: Integration verification (1 plan)
- Ready for execution

Plans:
- 10-01: Remove 8 orphan nodes
- 10-02: Extract container-update sub-workflow (DEBT-03)
- 10-03: Extract container-actions sub-workflow
- 10-04: Integration verification with user checkpoint

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-04 11:39:54 -05:00

119 lines
3.9 KiB
Markdown

# Roadmap — Unraid Docker Manager
## Milestones
- **v1.0 Docker Control via Telegram** — Phases 1-5 (shipped 2026-02-02) -> [Archive](milestones/v1.0-ROADMAP.md)
- **v1.1 n8n Integration & Polish** — Phases 6-9 (shipped 2026-02-04) -> [Archive](milestones/v1.1-ROADMAP.md)
- **v1.2 Modularization & Polish** — Phases 10-13 (planned)
---
## v1.2: Modularization & Polish
Modularize the workflow for maintainability, add "update all" functionality, fix callback data limits, and polish remaining issues.
### Phase 10: Workflow Modularization
**Goal:** Break main workflow into modular sub-workflows for maintainability
**Dependencies:** None
**Requirements:** MOD-01, MOD-02, DEBT-03
**Plans:** 4 plans
Plans:
- [ ] 10-01-PLAN.md — Orphan node cleanup (remove 8 orphan nodes before modularization)
- [ ] 10-02-PLAN.md — Extract container update sub-workflow (consolidates DEBT-03)
- [ ] 10-03-PLAN.md — Extract container actions sub-workflow (start/stop/restart)
- [ ] 10-04-PLAN.md — Integration verification and user checkpoint
**Success Criteria:**
1. Workflow split into logical sub-workflows (command routing, container operations, keyboard generation, etc.)
2. Sub-workflows callable from main without code duplication
3. Update flow consolidated between single and batch paths
4. All existing functionality still works after modularization
---
### Phase 11: Update All & Callback Limits
**Goal:** Add "update all" functionality and fix callback data limits for batch selection
**Dependencies:** Phase 10 (modularization provides cleaner base for new features)
**Requirements:** BATCH-04, BATCH-05, BATCH-06, BATCH-07
**Plans:** 0 plans
Plans:
- [ ] TBD (run /gsd:plan-phase 11 to break down)
**Success Criteria:**
1. User can type "update all" to update all :latest containers with confirmation
2. User can tap "Update All" in inline keyboard to update all :latest containers
3. Batch selection keyboard allows selecting 5+ containers without hitting callback limit
4. Containers with long names (20+ chars) can be selected in batch keyboard
---
### Phase 12: Polish & Audit
**Goal:** Clear Unraid update badges, verify environment configuration, and fix remaining tech debt
**Dependencies:** Phase 11 (features complete before polish)
**Requirements:** UNR-01, ENV-01, ENV-02, DEBT-02
**Plans:** 0 plans
Plans:
- [ ] TBD (run /gsd:plan-phase 12 to break down)
**Success Criteria:**
1. After bot successfully updates a container, Unraid UI no longer shows "update available" for that container
2. Documentation clarifies whether TELEGRAM_USERID env var is required or can be hardcoded
3. Documentation clarifies whether TELEGRAM_BOT_TOKEN env var is required or if n8n credential suffices
4. Image pull command has single --max-time flag (600s)
---
### Phase 13: Documentation Overhaul
**Goal:** Update README and documentation to reflect current architecture and features
**Dependencies:** Phase 12 (core features complete before documentation)
**Requirements:** DEBT-01
**Plans:** 0 plans
Plans:
- [ ] TBD (run /gsd:plan-phase 13 to break down)
**Success Criteria:**
1. README documents docker-socket-proxy architecture (not direct socket mount)
2. README documents all v1.2 features (update all, batch selection improvements)
3. Setup instructions verified accurate for clean install
---
## Progress
| Phase | Name | Milestone | Status |
|-------|------|-----------|--------|
| 1-5 | Foundation through Polish | v1.0 | Complete |
| 6 | n8n API Access | v1.1 | Complete |
| 7 | Socket Security | v1.1 | Complete |
| 8 | Inline Keyboard Infrastructure | v1.1 | Complete |
| 9 | Batch Operations | v1.1 | Complete |
| 10 | Workflow Modularization | v1.2 | Planned |
| 11 | Update All & Callback Limits | v1.2 | Pending |
| 12 | Polish & Audit | v1.2 | Pending |
| 13 | Documentation Overhaul | v1.2 | Pending |
**v1.2 Coverage:** 12 requirements mapped across 4 phases
---
*Updated: 2026-02-04 after Phase 10 planning*