GovOPlaN/govoplan-core
2
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity
Page: Repo docs DOCUMENTATION MAP
Pages
Codex Project Index Product govoplan govoplan concept dev Product govoplan split concept action plan Repo-README Repo README Repo docs ACCESS RBAC MODEL Repo docs ACTION EFFECT AUTOMATION LAYER Repo docs AUTOMATION CONTRACTS Repo docs CODEX WORKFLOW Repo docs COMPATIBILITY INVENTORY Repo docs COMPATIBILITY POLICY Repo docs CONFIGURATION PACKAGES Repo docs CONTEXTUAL HELP CONTRACT Repo docs DATAGRID SIZING CONTRACT Repo docs DEPENDENCY AUDITS Repo docs DEPLOYMENT OPERATOR GUIDE Repo docs DOCUMENTATION MAP Repo docs DURABLE RECOVERY OPERATIONS Repo docs EVENTS AND AUDIT Repo docs EXTERNAL REFERENCES AND INTEGRATION MATURITY Repo docs GITEA ISSUES Repo docs GOVERNANCE MODEL Repo docs GOVOPLAN MASTER ROADMAP Repo docs INFORMATION GOVERNANCE ADOPTION Repo docs INSTITUTIONAL CONTEXT CONTRACT Repo docs INTERFACE ETHICS AND DESIGN DOCTRINE Repo docs INTERFACE PATTERN MIGRATION Repo docs LOCALIZATION AND HELP QUALITY Repo-docs-MODULE-ARCHITECTURE Repo docs MODULE ARCHITECTURE Repo docs MODULE LIFECYCLE RECOVERY Repo docs POLICY CONTRACTS Repo docs POSTBOX E2EE ARCHITECTURE Repo docs PUBLIC SECTOR INTEGRATION STRATEGY Repo docs RECORDS FILING CONTRACT Repo-docs-RELEASE-DEPENDENCIES Repo docs RELEASE DEPENDENCIES Repo docs REMOTE WEBUI BUNDLES Repo docs SEARCH EVENT INDEXING CONTRACT Repo docs SECURITY AUDIT Repo docs SELF HOSTED INSTALLABILITY Repo docs STATE AND RECOVERY CONTRACT Repo docs TABULAR SOURCE CONTRACT Repo docs TEMPLATE CAPABILITY CONTRACT Repo docs TEMPORAL DATA CONTEXT Repo docs THEMING Repo docs THROTTLING Repo docs UI UX DECISION LEDGER Repo docs WEBUI BUNDLE BUDGETS Repo docs WEBUI MODULE PACKAGE LAYOUT Repo docs audits 2026 07 09 dependency audit
Clone
10
Repo docs DOCUMENTATION MAP
Albrecht Degering edited this page 2026-08-07 11:24:22 +02:00
Table of Contents

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.
Compatibility policy COMPATIBILITY_POLICY.md Supported database upgrade origins, portable-schema read/write windows, runtime/API alias retirement, and compatibility-code removal criteria.
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.
Action/effect automation layer ACTION_EFFECT_AUTOMATION_LAYER.md Action/effect contracts, consequence preview, runner semantics, and module boundary for automation.
External references and integration maturity EXTERNAL_REFERENCES_AND_INTEGRATION_MATURITY.md Stable external identity and cumulative connector maturity; configured source authority is defined by the meta target architecture.
Institutional context and governed references INSTITUTIONAL_CONTEXT_CONTRACT.md Shared temporal, actor/representation, institution, mandate, service, party, decision, evidence, legal-basis, information-governance, presentation, and geo DTO/provider contracts.
Provider-neutral record filing RECORDS_FILING_CONTRACT.md Exact source-revision identity, current source authorization, idempotent filing, capability discovery, and ownership boundary.
Temporal data read context TEMPORAL_DATA_CONTEXT.md Valid-time and recorded-time titlebar selection, HTTP/cache contract, security boundary, and module-adoption rule.
Cross-module information governance adoption INFORMATION_GOVERNANCE_ADOPTION.md Manifest evidence and enforcement rules for temporal browsing, purpose-aware access, retention, and institutional context.
Context-sensitive F1 help CONTEXTUAL_HELP_CONTRACT.md Focus, route, module-manifest documentation contexts, Docs projection, and hosted fallback.
German localization and help quality gate LOCALIZATION_AND_HELP_QUALITY.md German reference locale, new-installation default, catalog completeness, automatic page associations, and explicit-help review priorities.
Postbox E2EE target architecture POSTBOX_E2EE_ARCHITECTURE.md Strategic encrypted postbox/mailbox model, key ownership, role mailbox semantics, and retraction limits.
Shared state, runtime coordination, and recovery STATE_AND_RECOVERY_CONTRACT.md State profiles, object storage, node registration/drain, fenced leases, migration ordering, and recovery evidence.
Module lifecycle recovery MODULE_LIFECYCLE_RECOVERY.md Installer/live-graph recovery modes, deployment fence, evidence, retry blocking, and operator reconciliation.

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.
Self-hosted installability SELF_HOSTED_INSTALLABILITY.md Packaging decision, generated env templates, config validation, production-like dev stack commands, and boundary gate.
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.
WebUI loading and bundle budgets WEBUI_BUNDLE_BUDGETS.md Installed-module lazy boundaries, enforced initial/async budgets, and baseline measurements.

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.
Stable platform ideas govoplan/docs/PLATFORM_CORE_IDEAS.md Cross-product thesis, canonical distinctions, product experience rule, maturity rule, and decision test.
Current cross-product reconciliation govoplan/docs/STRATEGY_STATUS.md The only current prose status source; generated evidence and Gitea remain authoritative inputs.
Institutional governance target govoplan/docs/INSTITUTIONAL_GOVERNANCE_TARGET_ARCHITECTURE.md Cross-product semantic layers, source-authority modes, candidate Mandates/Services/Parties/Decisions boundaries, and migration sequence.
UI/UX decisions UI_UX_DECISION_LEDGER.md Binding guided-UI decisions, open decisions, impact index, and review checklist.
Core interface migration INTERFACE_PATTERN_MIGRATION.md Core-owned settings, credential, retention, lifecycle, and shared-component evidence for the product pattern language.
Interface ethics and design doctrine INTERFACE_ETHICS_AND_DESIGN_DOCTRINE.md Product-level doctrine for context, decision, consequence, contestability, responsibility, and traceability.
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.