ilia
f0eb795644
CI / skip-ci-check (pull_request) Successful in 31s
CI / docker-ci (pull_request) Successful in 35s
CI / python-lint (pull_request) Successful in 35s
CI / secret-scan (pull_request) Successful in 40s
CI / admin-unit (pull_request) Successful in 1m20s
CI / viewer-unit (pull_request) Successful in 2m50s
CI / e2e (pull_request) Successful in 3m16s
docs/archive is gitignored in this repo, so scratch plans stay under docs/ with an index note. Admin USER_GUIDE and related live guides keep the plain tone pass.
2.0 KiB
2.0 KiB
PunimTag documentation
Index for guides and reference. Style: see
~/Documents/code/project-template/docs/writing-docs.md.
Start here
| Doc | Purpose |
|---|---|
| ../README.md | What it is, install, config |
| QUICK_START.md | Run API, admin, viewer day to day |
| USER_GUIDE.md | Using admin and viewer features |
| ARCHITECTURE.md | Components and data flow |
| DEPLOYMENT.md | Deploy overview |
| RESOURCE_REQUIREMENTS.md | CPU, RAM, disk expectations |
Face matching
| Doc | Purpose |
|---|---|
| FACE_CONFIDENCE_CALIBRATION.md | Confidence scores |
| FACE_ACCURACY_STATUS.md | Accuracy notes |
| FACE_MATCH_ERROR_TAGGING.md | Error tagging |
Deploy (cPanel / scratch)
| Doc | Purpose |
|---|---|
| DEPLOY_FROM_SCRATCH.md | Fresh install |
| DEPLOY_CPANEL_STEP_BY_STEP.md | cPanel steps |
| INSTALL_PREREQUISITES_CPANEL.md | Host prerequisites |
Viewer
Prefer the live viewer README under viewer-frontend/. Older photo-viewer
planning docs are in archive/.
| Doc | Purpose |
|---|---|
| PERSON_CONTACT_AND_PENDING_DIGEST.md | Contact / digest flows |
| ADMIN_UX_REVIEW.md | Admin UX notes |
Archive
Historical plans, fix writeups, and restructure notes live in archive/. Do not treat them as current runbooks.
Historical / planning (read with care)
These are older plans and fix writeups, not day-to-day runbooks:
PHOTO_VIEWER_*.md,AUTO_MATCH_AUTOMATION_PLAN.md,RESTRUCTURE_SUMMARY.mdFIX_*.md,FIXES_*.md,DATABASE_ARCHITECTURE_REVIEW.md
Prefer USER_GUIDE.md, QUICK_START.md, and DEPLOYMENT.md.