Skip to content

Latest commit

 

History

History
20 lines (18 loc) · 1.71 KB

File metadata and controls

20 lines (18 loc) · 1.71 KB

ColorCraft documentation

Document Audience and purpose
Getting started Users and contributors who must install, start, stop, or recover ColorCraft.
User guide Users who create, review, save, manage, and export palettes.
Color analysis Readers who must interpret extraction, relationship, fit, and contrast results.
API contracts API consumers who need canonical routes, payloads, validation, and errors.
Architecture Contributors who need component boundaries and data flows.
Runtime configuration Operators who configure hosts, ports, CORS, browser launch, or trusted LAN access.
Persistence and privacy Users and operators who need storage, retention, migration, and security details.
Dashboard manifest Dashboard integrators who discover ColorCraft and resolve runtime endpoints.
Testing Contributors who run local and CI validation.
Troubleshooting Users and contributors who must recover from known failures.
Screenshot review Reviewers who generate or curate product screenshots.
Brand system Designers and UI contributors who apply the visual identity and product voice.
ColorCraft Technical English All documentation contributors who need the controlled writing and terminology standard.

The application code, API schemas, and tests are the source of truth for behavior. Update the relevant canonical document when behavior changes.