1.7 KiB
1.7 KiB
Shift documentation
Start with the user guide, then choose the engineering document that matches the work.
| Document | Audience | Contents |
|---|---|---|
../README.md / ../README.zh-CN.md |
Users | Features, formats, shortcuts, privacy, known limitations |
ARCHITECTURE.md |
Contributors | Process/window model, module ownership, events, data flows |
SPECIFICATION.md |
Product and QA | Observable behaviour, naming, limits, acceptance criteria |
SECURITY.md |
Security reviewers and maintainers | Trust boundaries, update and LAN risk, residual gaps |
ENGINEERING-NOTES.md |
Contributors | Regression ledger and non-negotiable implementation constraints |
RELEASE.md |
Release maintainers | Channel layout, signing, update handoff and verification |
BUILD_WINDOWS.md |
Builders | Windows prerequisites, cross-build and installer notes |
ROADMAP.md |
Contributors | Completed milestones and next desktop work |
MOBILE.md |
Product planning | Mobile feasibility and architecture plan |
../CONTRIBUTING.md |
Contributors | Setup, checks, change rules and manual matrix |
Source of truth
- Current code and tests define implemented behavior.
- The conversion/tool tables in
READMEdescribe the user-visible catalogue; the runtime catalogue lives insrc/lib/conversionFormats.tsandsrc/lib/radialOrder.ts. - Platform/runtime limitations must be stated as unverified when no real hardware run exists.
- Do not claim a CI run without linking its log.