[Feature] Publish full public GovOPlaN documentation #16

New Issue

zemion · 2026-07-09T16:13:18+02:00

zemion commented

2026-07-09 16:13:18 +02:00

Problem

Installed-system documentation is intentionally contextual: it shows the modules, permissions, routes, and configuration active in a specific GovOPlaN instance. GovOPlaN also needs a full documentation surface at govoplan.add-ideas.de where users, evaluators, operators, and developers can read product documentation without access to an installed system.

Proposed Capability

Provide a public full-documentation interface served outside an installed tenant context. It should use the same documentation content model where possible, but render the complete product/module documentation set instead of filtering to the current installation.

Ownership

Owning repository: govoplan-docs
Related module repositories: all modules that contribute docs topics
Extension point or integration boundary: documentation manifests/providers, public docs build/deploy pipeline, docs web UI routing

Acceptance Criteria

govoplan.add-ideas.de can expose a full GovOPlaN documentation entry point.
The public docs can render docs without tenant/session/configuration context.
The public docs tree uses the same broad taxonomy as the in-platform Help Center where it makes sense.
Module documentation can be included even when the module is not installed in a specific runtime instance.
The public docs clearly distinguish product-wide documentation from instance-specific documentation.
Repository docs and generated/runtime documentation have a defined source-of-truth relationship to avoid drift.

Verification Target

Public docs build or preview renders the full docs tree without an installed-system context.
A module topic contributed by a non-core module appears in the public docs.
The installed-system Help Center remains filtered to the current instance.

## Problem Installed-system documentation is intentionally contextual: it shows the modules, permissions, routes, and configuration active in a specific GovOPlaN instance. GovOPlaN also needs a full documentation surface at `govoplan.add-ideas.de` where users, evaluators, operators, and developers can read product documentation without access to an installed system. ## Proposed Capability Provide a public full-documentation interface served outside an installed tenant context. It should use the same documentation content model where possible, but render the complete product/module documentation set instead of filtering to the current installation. ## Ownership - Owning repository: `govoplan-docs` - Related module repositories: all modules that contribute docs topics - Extension point or integration boundary: documentation manifests/providers, public docs build/deploy pipeline, docs web UI routing ## Acceptance Criteria - [ ] `govoplan.add-ideas.de` can expose a full GovOPlaN documentation entry point. - [ ] The public docs can render docs without tenant/session/configuration context. - [ ] The public docs tree uses the same broad taxonomy as the in-platform Help Center where it makes sense. - [ ] Module documentation can be included even when the module is not installed in a specific runtime instance. - [ ] The public docs clearly distinguish product-wide documentation from instance-specific documentation. - [ ] Repository docs and generated/runtime documentation have a defined source-of-truth relationship to avoid drift. ## Verification Target - Public docs build or preview renders the full docs tree without an installed-system context. - A module topic contributed by a non-core module appears in the public docs. - The installed-system Help Center remains filtered to the current instance.

zemion added the

labels 2026-07-09 16:13:18 +02:00

zemion added the

module/docs

label 2026-07-10 19:50:49 +02:00

Sign in to join this conversation.