Files

28 lines
2.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# ZitPlane root MINIFEST
**Purpose:** index the Git-tracked project root files and top-level modules. Update when root files/directories are added, moved or removed. Subfolder contents live in the relevant `README.md` / `MINIFEST.md`, or in `project/SOURCE-INVENTORY.md` for the imported upstream snapshot.
| Direct child | Type | Purpose | Phase / status |
| --- | --- | --- | --- |
| `.gitea/` | folder | Gitea manual Actions workflow and README/MINIFEST | P05-CI-01; source ready, CI results pending |
| `auth/` | folder | P03 imported upstream Login V2 Next.js workspace under `ui/v2/` | P01/P03; source only |
| `core/` | folder | P02 official ZITADEL image/config plus dev helper | P01/P02; runtime unverified |
| `deployment/` | folder | Local-only Compose; no production stack | P01/P02 |
| `docs/` | folder | End-user/operator docs, existing phase evidence, `README.md` & `MINIFEST.md` | P01–P04/DOCS-01 |
| `notes/` | folder | Development plans, Scope Lock and chronological work/fix logs | DOCS-01 |
| `project/` | folder | Internal file/function/feature architecture and source mapping | DOCS-01 |
| `packages/` | folder | ZitPlane-owned shared package placeholder, not upstream Login deps | P01 |
| `scripts/` | folder | Future top-level scripts (current README placeholder only) | P01 |
| `tests/` | folder | P02 static/backend helper tests; no live authentication tests | P01/P02 |
| `users/` | folder | P04 separate Next.js Account Portal under `ui/` | P01/P04 |
| `.editorconfig` | file | Text/editor formatting defaults | P01 |
| `.env.example` | file | Non-secret P02 backend configuration keys | P02 |
| `.gitignore` | file | Secret/build artifact exclusion | P01 |
| `AGENTS.md` | file | Mandatory AI/developer scope, security and docs-first rules | P01/DOCS-01 |
| `MINIFEST.md` | file | This root map | DOCS-01 |
| `README.md` | file | Project entrypoint and roadmap/status | P01–P04/DOCS-01 |
**Not tracked:** root `.env` (secret dev data) and pre-existing unrelated `AI_INSTRUCTIONS.md` (untracked at this baseline). Do not stage either without explicit approval; `AI_INSTRUCTIONS.md` belongs to user and is not this manifest's tracked project content.
**Imported vendor exception:** The nested `auth/ui/v2/` upstream tree retains Git blob provenance. Do not inject `MINIFEST.md` or `README.md` into upstream vendor directories solely to satisfy the documentation rule; find all upstream files in `project/SOURCE-INVENTORY.md`.