Document photo-to-embroidery usage with max_colors in API docs #106

New issue

Closed

opened 2026-07-29 16:41:54 +00:00 by Mark · 0 comments

Mark commented

2026-07-29 16:41:54 +00:00

Owner

Goal

Update API documentation to cover photo-to-embroidery usage, explaining how max_colors works with the pre-quantization pipeline and providing examples.

Approach

Update docs/digitize.md with:
- Example showing photo upload with max_colors
- Explanation of the quantization pipeline
- Expected output quality for photographic vs. graphic inputs
- max_colors parameter documentation (default, valid range, behavior)
Update docstrings in src/service/handlers/digitize.py if needed

Acceptance Criteria

docs/digitize.md has a photo-to-embroidery section with example
max_colors parameter is documented with behavior explanation
All existing docs remain accurate

Files touched

docs/digitize.md
src/service/handlers/digitize.py (docstrings)

Decomposed from Mark/easystitch#101

## Goal Update API documentation to cover photo-to-embroidery usage, explaining how `max_colors` works with the pre-quantization pipeline and providing examples. ## Approach 1. Update `docs/digitize.md` with: - Example showing photo upload with `max_colors` - Explanation of the quantization pipeline - Expected output quality for photographic vs. graphic inputs - `max_colors` parameter documentation (default, valid range, behavior) 2. Update docstrings in `src/service/handlers/digitize.py` if needed ## Acceptance Criteria - [ ] `docs/digitize.md` has a photo-to-embroidery section with example - [ ] `max_colors` parameter is documented with behavior explanation - [ ] All existing docs remain accurate ## Files touched - `docs/digitize.md` - `src/service/handlers/digitize.py` (docstrings) --- _Decomposed from [Mark/easystitch#101](https://forgejo.tail018ac4.ts.net/Mark/easystitch/issues/101)_