From 7c521a6c1b7d5c6f797f50660881b47b28d9fe84 Mon Sep 17 00:00:00 2001 From: zemion Date: Thu, 9 Jul 2026 13:18:49 +0200 Subject: [PATCH] Sync Repo-docs-DOCUMENTATION-MAP from project files --- Repo-docs-DOCUMENTATION-MAP.-.md | 55 ++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 Repo-docs-DOCUMENTATION-MAP.-.md diff --git a/Repo-docs-DOCUMENTATION-MAP.-.md b/Repo-docs-DOCUMENTATION-MAP.-.md new file mode 100644 index 0000000..12ba4c6 --- /dev/null +++ b/Repo-docs-DOCUMENTATION-MAP.-.md @@ -0,0 +1,55 @@ + + +> Mirrored from `/mnt/DATA/git/govoplan-core/docs/DOCUMENTATION_MAP.md`. +> Origin: `repository`. +> Active tasks and changing state belong in Gitea issues; this wiki page is durable project context. + +--- +# GovOPlaN Documentation Map + +This map defines the source-of-truth documents for the current repository docs. +Use it to avoid duplicating long procedures across architecture, release, +operator, and roadmap pages. + +## Core Platform + +| Topic | Canonical document | Notes | +| --- | --- | --- | +| Module architecture and kernel contracts | `MODULE_ARCHITECTURE.md` | Stable module contracts, API efficiency contracts, durable boundary decisions, lifecycle, and WebUI contribution rules. | +| RBAC and resource access | `ACCESS_RBAC_MODEL.md` | Current permission, role, API-key, and resource-access model. | +| Governance hierarchy | `GOVERNANCE_MODEL.md` | System, tenant, user/group, campaign policy inheritance and admin UI structure. | +| Policy decision DTOs and provenance | `POLICY_CONTRACTS.md` | Shared explain/provenance shape; module-specific policy docs should link here. | +| Events and audit trace context | `EVENTS_AND_AUDIT.md` | Event dispatch semantics and audit payload conventions. | + +## Release And Operations + +| Topic | Canonical document | Notes | +| --- | --- | --- | +| Runtime configuration and operator flow | `DEPLOYMENT_OPERATOR_GUIDE.md` | Production/staging configuration, migrations, backups, installer operation, and rollback drill. | +| Release dependencies and catalogs | `RELEASE_DEPENDENCIES.md` | Release package refs, migration baselines, release lockfiles, catalog trust/licensing, catalog publishing, and release checklist. | +| Dependency vulnerability audits | `DEPENDENCY_AUDITS.md` | Local and CI audit commands plus dated audit result notes. | +| Remote WebUI bundle design | `REMOTE_WEBUI_BUNDLES.md` | Experimental controlled-deployment design; normal releases still use package builds. | + +## Product And Module Planning + +| Topic | Canonical document | Notes | +| --- | --- | --- | +| Product roadmap and module routing | `GOVOPLAN_MASTER_ROADMAP.md` | Product-level sequencing, implementation gates, issue routing, and missing-module decisions. | +| UI/UX decisions | `UI_UX_DECISION_LEDGER.md` | Binding guided-UI decisions, open decisions, impact index, and review checklist. | +| Public-sector integration posture | `PUBLIC_SECTOR_INTEGRATION_STRATEGY.md` | Strategy index; executable target inventory lives in `govoplan-connectors`. | +| Configuration packages | `CONFIGURATION_PACKAGES.md` | Package model, provider contract, import/export flow, and tracking slices. | + +## Workflow Docs + +| Topic | Canonical document | Notes | +| --- | --- | --- | +| Gitea issues and wiki sync | `GITEA_ISSUES.md` | Issue labels, imports, wiki mirroring, and Codex state updates. | +| Codex local workflow | `CODEX_WORKFLOW.md` | Local agent setup and focused verification commands. | + +## Cross-Repo Rule + +Core docs may keep strategy, kernel contracts, and routing decisions. Module +repositories should own executable module behavior, concrete API/UI contracts, +and operator notes for their own module. When content spans both, keep the +durable decision in core and link to the module document for implementation +details.