This directory separates maintained documentation from historical implementation records. Start here instead of searching by filename.
Version ứng dụng hiện tại: 2.5.0. pyproject.toml là nguồn version canonical;
UI và metadata đóng gói được sinh từ nguồn này.
- Terms of use — acceptable use, dependencies, and limitations.
- Privacy contract — diagnostic data, opt-out, and retention.
- Moodle Web Services — Moodle endpoints and verified assignment workflow semantics.
- UTH Portal API — redacted reverse-engineered Portal contracts.
- Windows packaging — build, verify, sign, and package the Windows release.
- Gitflow policy — branch direction, merge contract, and GitHub ruleset enforcement.
- Theme system — semantic color contract, dark-theme design, accessibility checks, and runtime refresh rules.
- UI platform preview — safely render Android, iOS, or desktop presentation on another runtime.
- Notification E2E matrix — automated and real-device evidence expected per platform.
- Package performance — measured APK/IPA size, packaging tradeoffs and isolated Windows installation benchmarks.
- Android device performance — physical tablet runtime checks and isolated install measurements that preserve user data.
- Architecture decisions — accepted decisions that constrain current code.
- Refactoring plan — the 2026-07-01 audit and phased baseline.
- Refactoring log — dated decisions and completed verification evidence.
These files preserve context, but an accepted ADR and executable tests take precedence when historical notes disagree with current behavior.
archive/designs/contains approved design snapshots.archive/implementation-plans/contains the corresponding step-by-step implementation plans.
Archived files are provenance, not an active backlog. Their branch names, commands, checkboxes, paths, and original status describe the repository at the recorded date.
- Put durable decisions in
adr/, current operating instructions inguides/, API contracts inapi/, and test matrices intesting/. - Move completed planning artifacts to
archive/; do not leave tool-specific working directories at the top level ofdocs/. - Use lowercase kebab-case names for new files, except stable public contracts such
as
PRIVACY.md. - Never commit HAR files, raw network captures, tokens, cookies, credentials, or identifiable production payloads. Keep research evidence in the ignored local research area and copy only redacted findings into maintained docs.
- Do not commit transient screenshots or generated reports unless a maintained document links to them and states how they are refreshed.