Docs: adopt ColorCraft Technical English and refresh product documentation#8
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Base main commit:
f58e6417c84feecf86cecd76a7049711d6f94036Governance
ColorCraft Technical English is informed by ASD-STE100 principles. ColorCraft does not claim formal ASD-STE100 compliance. No ASD-STE100 controlled-dictionary content was copied.
The standard defines three application levels, procedure and error patterns, required domain distinctions, and preferred ColorCraft terminology. Application code, API schemas, and tests remain the source of truth for behavior.
Documentation structure
New canonical documents:
docs/writing-style.mddocs/color-analysis.mddocs/user-guide.mdUpdated canonical documents:
README.mdanddocs/README.mddocs/getting-started.mddocs/architecture.mddocs/api-contracts.mddocs/runtime-configuration.mddocs/persistence-and-privacy.mddocs/testing.mddocs/troubleshooting.mddocs/brand-system.mdCONTRIBUTING.mdRemoved obsolete duplicate documents:
docs/api.mdanddocs/user-workflow.md.Product and technical corrections
VITE_COLORCRAFT_API_URL; remove the nonexistentVITE_API_URLandCOLORCRAFT_NO_BROWSERclaims; state that the launcher does not open a browser.docs/api-contracts.md, including FastAPI/docsand/openapi.json.The task brief described palettes as entirely session-only and stated that no saved-palette library existed. Current
mainincludes the merged IndexedDB Palette Library. These documents therefore follow current source truth: saved palette records persist in IndexedDB, while source-image bytes, analysis, suggestions, unsaved changes, and previews remain session-only. Browser history stores the active view and Review tab, not palette data.Application copy follow-ups
No production copy changes are included. Confirmed follow-ups:
Local onlystatus badge is ambiguous when trusted LAN access is configured and does not by itself mean private, secure, offline, or persistent.Moodand factual-sounding subjective claims such as “maximum contrast and visual energy”; this conflicts with the measured-versus-recommended distinction.Screenshots
No screenshots changed. The README references the current curated Review and Palette Library screenshots. The older committed screenshot set is not referenced by current documentation, so this PR does not replace it or commit temporary browser-review output.
Validation
Passed:
backend\.venv311\Scripts\python.exe -m pytest tests/test_docs.py -q— 2 passed; Markdown links and curated image paths verified.backend\.venv311\Scripts\python.exe -m compileall -q backendcorepack pnpm@9.15.9 exec prettier --check . --end-of-line auto— all matched frontend files pass formatting.check.pystages — ESLint, TypeScript, 67 Vitest tests with coverage, production build, Ruff format/lint, mypy, 59 pytest tests with coverage, and 2 Playwright/axe workflows passed.git diff --checkOn this Windows checkout, the unmodified frontend working files are converted to CRLF by
core.autocrlf=true, so the unmodified firstcheck.pyPrettier step reports 68 line-ending-only warnings. The repository index is LF, the equivalent Prettier check with--end-of-line autopasses, and GitHub Actions checks the LF repository content.Scope confirmation
node_modules, build output, temporary screenshots, uploaded images, or other local/generated files were committed.Ready for review. Do not merge as part of this task.