Decompose: Stale documentation cleanup (project_summary, module_structure, roadmap) — Phase 3: roadmap.md update #59

New issue

Closed

opened 2026-06-22 16:31:30 +00:00 by Mark · 0 comments

Mark commented

2026-06-22 16:31:30 +00:00

Owner

Phase 3: roadmap.md update

Goal: Update the roadmap to reflect the current state and the
new service direction.

Files:

Modify: docs/roadmap.md

Acceptance:

Phases 1–3 are updated to reflect the actual current scope (not just
DST; PES/EXP/JEF; not 57 tests; etc.).
A new "Phase 5: Service deployment" section is added covering the
HTTP service (issue #31), the ThreadCraft integration
(ThreadCraft #11), and the operational concerns from issues #40, #43.
The GUI (Phase 4) is decoupled — it's a separate repo (per issue #44),
not part of this roadmap.
A "Last updated" date at the top of the doc.

Depends on: P1, P2 (so the roadmap doesn't reference stale structure
or counts).

Out of scope

Other docs in docs/ (api_documentation.md, developer_guide.md, etc.)
may also be stale, but those are lower-priority for new-contributor
onboarding. File separate tickets for them if needed.
Generating docs from code (a Python script that emits structural
overview from src/) is a larger refactor; out of scope for this
cleanup.

Decomposed from easystitch#39

## Phase 3: roadmap.md update **Goal:** Update the roadmap to reflect the current state and the new service direction. **Files:** - Modify: `docs/roadmap.md` **Acceptance:** - Phases 1–3 are updated to reflect the actual current scope (not just DST; PES/EXP/JEF; not 57 tests; etc.). - A new "Phase 5: Service deployment" section is added covering the HTTP service (issue #31), the ThreadCraft integration (ThreadCraft #11), and the operational concerns from issues #40, #43. - The GUI (Phase 4) is decoupled — it's a separate repo (per issue #44), not part of this roadmap. - A "Last updated" date at the top of the doc. **Depends on:** P1, P2 (so the roadmap doesn't reference stale structure or counts). ## Out of scope - Other docs in `docs/` (api_documentation.md, developer_guide.md, etc.) may also be stale, but those are lower-priority for new-contributor onboarding. File separate tickets for them if needed. - Generating docs from code (a Python script that emits structural overview from `src/`) is a larger refactor; out of scope for this cleanup. --- _Decomposed from [easystitch#39](https://forgejo.tail018ac4.ts.net/Mark/easystitch/issues/39)_