Files

2.7 KiB

project/ — Developer knowledge base (source of implementation truth)

This Git-tracked folder describes how ZitPlane is built, what each first-party module/file/function does, why technologies are used, how components communicate, the implementation status of each feature/page, and exactly which phase changed each part.

Use this folder for architecture, behavior and maintainers' internal details. Use notes/ for pre-change scope/decisions/checkpoint logs; use docs/ for end-user usage and practical setup instructions.

Mandatory update workflow

  1. Before any code or configuration change, create a dated, scoped plan in notes/.
  2. Identify every relevant entry in FILE-MAP.md, FUNCTIONS.md, FEATURES-AND-PAGES.md and SETUP-AND-DEPENDENCIES.md.
  3. During/after implementation, update those exact descriptions: what changed, reason, location, API/flow impacts, dependencies, security effects, status, test evidence, commit reference.
  4. Update CHANGELOG.md, relevant docs/ user guides, and manifests in the same approved phase.
  5. Record verified facts only. Distinguish source-implemented from test-passed and deployed. Never invent a button, feature, exact endpoint, passing test or production state.

Key entrypoints

The upstream ZITADEL Login V2 was imported unmodified from a pinned revision. Its own read-only internals should be referenced with exact file paths (and added to this knowledge base when modified in an approved later phase), not silently replaced with guessed descriptions.

Security: This is public-repository-appropriate documentation. Never include credentials, session cookies, real account IDs, tokens, production data or sensitive configuration values.

P05 CI developer entrypoint

Read CI-ARCHITECTURE.md for workflow responsibilities, dependency lockfile reconciliation, smoke coverage and outstanding full OIDC gates. CI executes only on Gitea, not the developer PC.