This directory is the active documentation surface for the glyph codec.
If you only read three files, read these:
- ../README.md — codec-first repo overview and install matrix
- QUICKSTART.md — minimal verified examples
- API_REFERENCE.md — current package names and language doc links
- LOOSE_MODE_SPEC.md — loose mode and canonicalization
- GS1_SPEC.md — multiplexed streaming protocol
- AGENTS.md — optional higher-level examples built on the codec
- GUIDE.md — broader concepts and patterns
- SPECIFICATIONS.md — overview-level technical summary
- ../py/README.md
- ../go/README.md
- ../js/README.md
- ../rust/glyph-codec/README.md
- ../c/glyph-codec/README.md
These files are still useful, but they are not the source of truth for the current codec surface:
- reports/README.md — dated research and benchmark snapshots
- archive/README.md — archived docs and experiments
- ../AGENT.md — older positioning note; may drift from current repo direction
- ../DEMO_README.md and ../DEMO_QUICK_REFERENCE.md — legacy demo material
- visual-guide.html — visual explainer, not authoritative API/spec text
- Specs beat guides.
- Manifests beat README install snippets.
- Language READMEs should document the shipped package names and exported APIs.
- Demo docs and reports must be clearly marked when they are historical or example-only.
Some older report/demo files still contain dated package names, benchmark timestamps, or example integrations. Those files should be treated as historical context unless they are explicitly refreshed.