Files
ZitPlane/docs/README.md
T

29 lines
3.5 KiB
Markdown
Raw Normal View History

# docs/ — ZitPlane User & Operator Documentation
**Purpose:** the Git-tracked, **user-facing** knowledge base: real functions, pages, controls, account behavior, prerequisites, how to use each available capability, troubleshooting and limitations.
**Current product status:** P02 local backend Compose, P03 imported Login V2 source, P04 account portal source. No integrated deployed product yet; Gitea Run #86 verified disposable backend readiness/persistence, Run #89 verified Login frozen build/unit/security and Run #87 verified Account build/security. **Real authenticated user login/MFA and production deployment remain unverified.** **Do not claim pages/buttons are working in production merely because source exists.**
## What to read
1. [USER-GUIDE.md](USER-GUIDE.md) — every currently first-party Account Portal page, button and link, security/login semantics.
2. [SETUP-GUIDE.md](SETUP-GUIDE.md) — current dev stack prerequisites, account OIDC setup plan, configuration variables and boundaries.
3. [FEATURES-STATUS.md](FEATURES-STATUS.md) — implemented vs not yet integrated/tested/available.
4. [TROUBLESHOOTING.md](TROUBLESHOOTING.md) — common observable issues and *safe* diagnosis.
5. [DEVELOPMENT.md](DEVELOPMENT.md) — existing developer quick start; includes pending CI/testing warnings.
6. [ARCHITECTURE.md](ARCHITECTURE.md) — architecture overview (technical context).
7. [PHASES.md](PHASES.md), [P02-EVIDENCE.md](P02-EVIDENCE.md), [P03-SOURCE-IMPORT.md](P03-SOURCE-IMPORT.md), [P04-ACCOUNT-PORTAL.md](P04-ACCOUNT-PORTAL.md) — historical implemented source details and acceptance limits.
8. [MINIFEST.md](MINIFEST.md) — exact files and purposes.
## Rules for every future developer/AI agent
- Update the **corresponding user guide and button/page instructions in the same approved phase** as code changes.
- For each feature: name, who can use it, URL, action/button, what data it shows or changes, errors/permissions, prerequisites, exact current status and verified evidence.
- Do **not** copy implementation internals here as the only explanation; put developer file/function details under `project/`.
- Do not omit known restrictions or advertise planned abilities as live.
- Never publish real personal user data, passwords, access tokens or secrets.
Full update policy is in root [AGENTS.md](../AGENTS.md). A list of available docs is in [MINIFEST.md](MINIFEST.md).
For the latest **Run #95 private proxy readiness failure** and scoped CI-only forwarder design, see [P05-OIDC-04.md](P05-OIDC-04.md); real OIDC still NOT EXECUTED. For the **terminal Run #93 failure** and verified private port-8080 bind conflict, see [P05-OIDC-03-A02.md](P05-OIDC-03-A02.md). The former [queue audit](P05-OIDC-03-A01.md) is historical: the runner subsequently started job #206. The [P05-OIDC-03 CI implementation](P05-OIDC-03.md) remains unaccepted for real OIDC. Historical Run #91 exit-code blocker and safe cleanup are in [P05-OIDC-02.md](P05-OIDC-02.md). For the previous Run #90 blocker and cleanup see [P05-OIDC-01.md](P05-OIDC-01.md). For Gitea Run #89 final Login frozen build/unit/zero-advisory acceptance see [P05-SEC-02-A01.md](P05-SEC-02-A01.md). For Run #88 historical blocker and corrected helper see [P05-SEC-02.md](P05-SEC-02.md). For Gitea Run #87 findings see [P05-SEC-01.md](P05-SEC-01.md). For backend-only isolated runtime verification see [P05-CI-03.md](P05-CI-03.md); for initial full workflow and its limitations see [P05-CI-01.md](P05-CI-01.md). A green backend discovery smoke is not an authenticated user-login result.