[Feature] Make GovOPlaN documentation version-aware #17

New Issue

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

zemion commented

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

Problem

GovOPlaN documentation must match the version being used. Public docs should allow readers to choose among supported GovOPlaN/module versions. Installed-system docs should show the documentation for the installed versions, not only the latest documentation text.

Proposed Capability

Make the documentation content model, API, and UI version-aware. Public docs should support version selection. Runtime Help Center docs should resolve topics against the installed module versions and platform version reported by the running system.

Ownership

Owning repository: govoplan-docs
Related module repositories: all modules that publish versioned docs topics
Related core boundary: module manifests, module/version registry, docs context API
Extension point or integration boundary: docs topic metadata, docs API query parameters, public docs version selector, installed-version resolution

Acceptance Criteria

Documentation topics declare the GovOPlaN/module version or version range they apply to.
Public docs expose a version selector and can render docs for supported versions.
Public docs define behavior for latest, stable, older supported, and unsupported/EOL versions.
Installed-system docs resolve documentation using installed platform/module versions.
The docs context API exposes enough version metadata for the UI to explain which version is being shown.
Version fallback behavior is explicit when exact docs for an installed version are unavailable.
Tests cover public-version selection and installed-version filtering.

Verification Target

Public docs preview can switch between at least two documentation versions.
Installed-system docs show the version selected from the module registry/context.
A topic that only applies to a newer version is hidden or clearly marked when viewing an older version.

## Problem GovOPlaN documentation must match the version being used. Public docs should allow readers to choose among supported GovOPlaN/module versions. Installed-system docs should show the documentation for the installed versions, not only the latest documentation text. ## Proposed Capability Make the documentation content model, API, and UI version-aware. Public docs should support version selection. Runtime Help Center docs should resolve topics against the installed module versions and platform version reported by the running system. ## Ownership - Owning repository: `govoplan-docs` - Related module repositories: all modules that publish versioned docs topics - Related core boundary: module manifests, module/version registry, docs context API - Extension point or integration boundary: docs topic metadata, docs API query parameters, public docs version selector, installed-version resolution ## Acceptance Criteria - [ ] Documentation topics declare the GovOPlaN/module version or version range they apply to. - [ ] Public docs expose a version selector and can render docs for supported versions. - [ ] Public docs define behavior for latest, stable, older supported, and unsupported/EOL versions. - [ ] Installed-system docs resolve documentation using installed platform/module versions. - [ ] The docs context API exposes enough version metadata for the UI to explain which version is being shown. - [ ] Version fallback behavior is explicit when exact docs for an installed version are unavailable. - [ ] Tests cover public-version selection and installed-version filtering. ## Verification Target - Public docs preview can switch between at least two documentation versions. - Installed-system docs show the version selected from the module registry/context. - A topic that only applies to a newer version is hidden or clearly marked when viewing an older version.

zemion added the

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

zemion added the

module/docs

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

Sign in to join this conversation.