luckberg/unraid-docker-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: formalize v1.2 requirements and roadmap

Browse Source 
12 requirements across 3 phases:
- Phase 10: Modularization, update all, callback limits (7 reqs)
- Phase 11: Unraid sync, env audit, tech debt (4 reqs)
- Phase 12: Documentation overhaul (1 req)

Removed WEB-01 (webhook fix) - already resolved.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Lucas Berger
2026-02-04 11:21:31 -05:00
parent 6a0551e0d6
commit 63df54e8e3
4 changed files with 154 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.planning/ROADMAP.md
+21 -18
View File
@@ -10,15 +10,15 @@
## v1.2: Modularization & Polish
Complete remaining v1.1 scope: modularize workflow for maintainability, fix webhook issues, audit environment variables, and clear Unraid update badges.
Modularize the workflow for maintainability, add "update all" functionality, fix callback data limits, and polish remaining issues.
### Phase 10: Workflow Modularization
### Phase 10: Workflow Modularization & Update All
**Goal:** Break main workflow into modular sub-workflows for maintainability
**Goal:** Break main workflow into modular sub-workflows and add "update all" functionality with improved callback data handling
**Dependencies:** None
**Requirements:** TBD (carried from Phase 9.1)
**Requirements:** MOD-01, MOD-02, BATCH-04, BATCH-05, BATCH-06, BATCH-07, DEBT-03
**Plans:** 0 plans
@@ -26,17 +26,23 @@ Plans:
- [ ] TBD (run /gsd:plan-phase 10 to break down)
**Success Criteria:**
[To be defined during planning]
1. Workflow split into logical sub-workflows (command routing, container operations, keyboard generation, etc.)
2. Sub-workflows callable from main without code duplication
3. User can type "update all" to update all :latest containers with confirmation
4. User can tap "Update All" in inline keyboard to update all :latest containers
5. Batch selection keyboard allows selecting 5+ containers without hitting callback limit
6. Containers with long names (20+ chars) can be selected in batch keyboard
7. Update flow consolidated between single and batch paths
---
### Phase 11: Polish & Audit
**Goal:** Clear Unraid update badges, fix webhook issues, verify environment configuration, and address v1.1 tech debt
**Goal:** Clear Unraid update badges, fix webhook issues, verify environment configuration, and fix remaining tech debt
**Dependencies:** Phase 10 (modularization complete before polish)
**Requirements:** UNR-01, ENV-01, ENV-02, WEB-01
**Requirements:** UNR-01, ENV-01, ENV-02, DEBT-02
**Plans:** 0 plans
@@ -47,22 +53,17 @@ Plans:
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. Telegram webhook works when workflow is published (bot responds without manual execute)
**Tech Debt from v1.1 (to address):**
- README.md lines 14-34: Still documents direct docker.sock mounting (should document proxy architecture)
- Duplicate --max-time flags in image pull command (600 then 5, last wins — should keep only 600s)
- Update flow duplicated between single and batch paths (consolidation opportunity)
4. Image pull command has single --max-time flag (600s)
---
### Phase 12: Documentation Overhaul
**Goal:** [To be planned]
**Goal:** Update README and documentation to reflect current architecture and features
**Dependencies:** Phase 11 (core features complete before documentation)
**Requirements:** TBD
**Requirements:** DEBT-01
**Plans:** 0 plans
@@ -70,7 +71,9 @@ Plans:
- [ ] TBD (run /gsd:plan-phase 12 to break down)
**Success Criteria:**
[To be defined during planning]
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
---
@@ -83,11 +86,11 @@ Plans:
| 7 | Socket Security | v1.1 | Complete |
| 8 | Inline Keyboard Infrastructure | v1.1 | Complete |
| 9 | Batch Operations | v1.1 | Complete |
| 10 | Workflow Modularization | v1.2 | Pending |
| 10 | Workflow Modularization & Update All | v1.2 | Pending |
| 11 | Polish & Audit | v1.2 | Pending |
| 12 | Documentation Overhaul | v1.2 | Pending |
**v1.2 Coverage:** 4 requirements mapped (UNR-01, ENV-01, ENV-02, WEB-01), modularization TBD
**v1.2 Coverage:** 12 requirements mapped across 3 phases
---
*Updated: 2026-02-04 after v1.1 milestone*