The single index of design documentation. Documents under .github/docs/ are for contributors and design; user-facing documentation (usage, migration, capacity tables) lives in docs/.
Authoring rules, document types, and naming conventions: docs_authoring_guidelines.md.
| Document | Covers |
|---|---|
| DESIGN.md | Library design principles (English + Japanese) |
Design records and spec-to-code maps for shipped behavior, organized symbology-first.
| Document | Type | Covers |
|---|---|---|
| qrcode-symbologies.md | Architecture record | Symbology model, shared vs per-symbology components, API and data-model direction, scope decisions |
| standardqr-spec-map.md | Spec-to-code map | Standard QR pipeline vs ISO/IEC 18004 |
| standardqr-decoder.md | Design record | Standard QR decoder scope, input tiers, lessons learned |
| qrcode-test-fixtures.md | Design record | Committed fixture corpus, manifest schema, external-oracle capability matrix |
| microqr-spec-map.md | Spec-to-code map | Micro QR encoding pipeline vs ISO/IEC 18004 |
| rmqr-spec-map.md | Spec-to-code map | rMQR pipeline vs ISO/IEC 23941 (encoder, rendering, matrix decoder and image detection implemented) |
| rmqr-encoder.md | Design record | rMQR encoder API, oracle-verified symbol parameter tables, decisions, verification record (spec-first) |
| rmqr-decoder.md | Design record | rMQR decoder scope (matrix and image level), image detection design (format-first, sub-finder anchored, gated perspective search), decisions incl. the open misdecode-protection question, lessons |
Forward-looking strategy; durable decisions graduate into specs/ after implementation.
| Document | Covers |
|---|---|
| skiasharp-qrcode-microqr-rmqr-implementation-plan.md | Micro QR / rMQR implementation order (Phase 0-8) |
| skiasharp-qrcode-rmqr-implementation-plan.md | rMQR detailed plan (Phases 5-7 sub-phases, API decisions, oracles, exit gates) |
| skiasharp-qrcode-microqr-rmqr-test-strategy.md | Micro QR / rMQR test strategy (oracles, fixtures, CI design) |