Decompose: Stale documentation cleanup (project_summary, module_structure, roadmap) — Phase 1: project_summary.md rewrite #57

Closed
opened 2026-06-22 16:31:28 +00:00 by Mark · 0 comments
Owner

Phase 1: project_summary.md rewrite

Goal: Replace the stale "MVP COMPLETE" framing with a current
description of easyStitch.

Files:

  • Modify: docs/project_summary.md

Acceptance:

  • Module tree matches find src -type f -name "*.py" | sort.
  • Status line is accurate (active development, not "MVP complete").
  • Stale claims about test counts and format support are corrected.
  • PES/EXP/JEF generators are mentioned.
  • The Qt6 GUI is mentioned but flagged as not on the service critical
    path.

Why first: this is the doc most likely to be read first by a new
contributor. Getting it right is the highest-value single fix.



Decomposed from easystitch#39

## Phase 1: project_summary.md rewrite **Goal:** Replace the stale "MVP COMPLETE" framing with a current description of easyStitch. **Files:** - Modify: `docs/project_summary.md` **Acceptance:** - Module tree matches `find src -type f -name "*.py" | sort`. - Status line is accurate (active development, not "MVP complete"). - Stale claims about test counts and format support are corrected. - PES/EXP/JEF generators are mentioned. - The Qt6 GUI is mentioned but flagged as not on the service critical path. **Why first:** this is the doc most likely to be read first by a new contributor. Getting it right is the highest-value single fix. --- --- _Decomposed from [easystitch#39](https://forgejo.tail018ac4.ts.net/Mark/easystitch/issues/39)_
Mark 2026-06-23 06:41:38 +00:00
  • closed this issue
  • removed the
    quickfix
    label
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Mark/easystitch#57
No description provided.