Decompose: Service documentation (architecture, deployment, performance, development) — Phase 1: Architecture overview + API reference #60

New issue

Closed

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

Mark commented

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

Owner

Phase 1: Architecture overview + API reference

Goal: The "what is this service" doc. New operators should be able
to read this and understand the system shape.

Files:

New: docs/service/architecture.md (system diagram, components,
data flow)
New: docs/service/api.md (full endpoint list, request/response
shapes, error codes, content types, auth model)

Acceptance:

docs/service/architecture.md has a Mermaid or ASCII diagram
showing the service in context (ThreadCraft client → easyStitch
service → internal pipeline → embroidery file output).
docs/service/api.md covers every endpoint from issue #31 (P2–P4)
with example request/response for each, error codes, content types.
Both docs link to the relevant code (src/service/) and to the
related tickets/issues.

Why first: the API reference is needed by anyone integrating with
the service (including ThreadCraft). Without it, integrations guess at
shapes.

Decomposed from easystitch#40

## Phase 1: Architecture overview + API reference **Goal:** The "what is this service" doc. New operators should be able to read this and understand the system shape. **Files:** - New: `docs/service/architecture.md` (system diagram, components, data flow) - New: `docs/service/api.md` (full endpoint list, request/response shapes, error codes, content types, auth model) **Acceptance:** - `docs/service/architecture.md` has a Mermaid or ASCII diagram showing the service in context (ThreadCraft client → easyStitch service → internal pipeline → embroidery file output). - `docs/service/api.md` covers every endpoint from issue #31 (P2–P4) with example request/response for each, error codes, content types. - Both docs link to the relevant code (`src/service/`) and to the related tickets/issues. **Why first:** the API reference is needed by anyone integrating with the service (including ThreadCraft). Without it, integrations guess at shapes. --- --- _Decomposed from [easystitch#40](https://forgejo.tail018ac4.ts.net/Mark/easystitch/issues/40)_