docs: establish ZitPlane notes project and user documentation governance

This commit is contained in:
Vib Tools committed 2026-11-22 04:40:27 -08:00
1 parent 40af500750
commit 7ecf531697
22 files changed
+1507

No files matched your search

+12
View File
@@ -9,6 +9,18 @@ Compact, developer-friendly monorepo for a central identity service, a branded l
- **P04 Account Portal:** Next.js + ZITADEL OIDC Auth.js source, server-protected overview/profile/security pages and compact responsive foundation implemented under `users/ui/`. **No build/test/runtime validation yet; future Gitea Actions required.**
- **Production / Coolify:** not configured or deployed.
## Documentation and project knowledge
ZitPlane uses three **Git-tracked Markdown areas**. For every future feature, change or fix, create the plan **before editing code** and update all affected documentation in the same phase:
| Folder | Who reads it | What's inside |
| --- | --- | --- |
| [`notes/`](notes/README.md) | Developers / AI agents during work | Scope locks, pre-change plans, phase/fix logs, decisions, verification outcomes |
| [`project/`](project/README.md) | Maintainers / developers / AI agents | Real file/function map, feature/page details, architecture, modules, dependencies, change history and full source index |
| [`docs/`](docs/README.md) | End users / operators / developers | Page and button usage, onboarding, status, setup steps, troubleshooting and known limitations |
Each of these folders contains `README.md` and the requested literal `MINIFEST.md` (direct-child list, purpose, phase and status). The root [MINIFEST.md](MINIFEST.md) indexes top-level content. Rules are mandatory in [AGENTS.md](AGENTS.md). Imported official Login V2 source remains untouched.
## Responsibility map
| Path | Purpose |