ilia
655a12963b
Replace marketing feature walls with a plain install/config README and short entry guides per project-template docs/writing-docs.md.
1.6 KiB
1.6 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.