govoplan-docs/README.md

govoplan-docs

Repository type: module (platform).

GovOPlaN Docs provides the documentation layer for configured GovOPlaN systems.

It answers "what does this installation provide for me?" before it answers "what could the full product do?". The goal is to reduce documentation complexity by starting from installed modules, enabled configuration, tenant policy, role, route availability, and visible capabilities.

Ownership

This repository owns:

• backend module manifest docs
• configured-system documentation indexing
• documentation source and contribution contracts
• role-aware and tenant-aware documentation filtering
• evidence pages for disabled, unavailable, or optional capabilities
• documentation route contributions and future WebUI package @govoplan/docs-webui
• documentation sync/import tooling that belongs to the runtime docs layer rather than the repository maintenance scripts

Core owns module discovery, configuration package loading, route registry, RBAC evaluation, capability registry, and shared WebUI shell behavior.

Documentation model

The docs module should render documentation in three layers:

• Configured: installed and enabled behavior that applies to the current tenant, organization, role, or route.
• Available: installed but disabled or hidden behavior that can be enabled by configuration or permission.
• Evidence: referenced capabilities, modules, examples, or product documentation that explain what else may be possible without making it the primary reading path.

Module integration

Backend entry point:

[project.entry-points."govoplan.modules"]
docs = "govoplan_docs.backend.manifest:get_manifest"

Frontend package:

@govoplan/docs-webui

Platform module manifests, configuration packages, release catalogs, and governance rules are documented in govoplan-core/docs/.

Concept documents

• docs/DOCUMENTATION_LAYER_CONCEPT.md defines the configured, available, and evidence documentation model.
• docs/INSTANCE_AWARE_DOCUMENTATION.md defines the runtime context and condition model.
• docs/DOCUMENTATION_EXPERIENCE_CONCEPT.md defines the workflow, structure/reference, and design-pattern documentation experience.