[Docs] Personalize user documentation by enabled modules and unavailable capabilities #206

New Issue

zemion · 2026-07-07T13:55:41+02:00

zemion commented

2026-07-07 13:55:41 +02:00

Goal

Show user documentation that matches the current GovOPlaN instance while still making unavailable capabilities discoverable and understandable.

Scope

Filter or annotate documentation by enabled modules, granted permissions, and configured integrations.
Clearly mark features that are not available in the current instance and explain why: missing module, disabled capability, missing permission, or missing external integration/configuration.
Keep the default user docs readable by hiding irrelevant detail until requested.
Link unavailable features to concise context showing what would become possible with additional modules.
Preserve admin/operator documentation for diagnosing missing capabilities.

Acceptance Criteria

A normal user sees docs that reflect the current instance without dead-end instructions.
Unavailable features have a clear reason and, where useful, a module/integration hint.
The documentation system consumes module/capability metadata instead of hard-coded module assumptions.
The approach works for partial deployments and future modules.

## Goal Show user documentation that matches the current GovOPlaN instance while still making unavailable capabilities discoverable and understandable. ## Scope - Filter or annotate documentation by enabled modules, granted permissions, and configured integrations. - Clearly mark features that are not available in the current instance and explain why: missing module, disabled capability, missing permission, or missing external integration/configuration. - Keep the default user docs readable by hiding irrelevant detail until requested. - Link unavailable features to concise context showing what would become possible with additional modules. - Preserve admin/operator documentation for diagnosing missing capabilities. ## Acceptance Criteria - A normal user sees docs that reflect the current instance without dead-end instructions. - Unavailable features have a clear reason and, where useful, a module/integration hint. - The documentation system consumes module/capability metadata instead of hard-coded module assumptions. - The approach works for partial deployments and future modules.

zemion added the

labels 2026-07-07 23:08:20 +02:00

zemion added the

module/core

label 2026-07-07 23:42:26 +02:00

zemion commented

2026-07-08 20:59:30 +02:00

Codex State: done

Summary

Instance-aware documentation now exposes structured blockers for modules, capabilities, and permissions so unavailable docs can explain why they are hidden or locked.

Changed Files

govoplan-docs/src/govoplan_docs/backend/api/v1/routes.py
govoplan-docs/webui/src/features/docs/DocsPage.tsx
govoplan-docs/docs/INSTANCE_AWARE_DOCUMENTATION.md

Verification

Focused checks passed where available; see working-tree validation summary in Codex final response.

## Codex State: done ### Summary - Instance-aware documentation now exposes structured blockers for modules, capabilities, and permissions so unavailable docs can explain why they are hidden or locked. ### Changed Files - `govoplan-docs/src/govoplan_docs/backend/api/v1/routes.py` - `govoplan-docs/webui/src/features/docs/DocsPage.tsx` - `govoplan-docs/docs/INSTANCE_AWARE_DOCUMENTATION.md` ### Verification - Focused checks passed where available; see working-tree validation summary in Codex final response.

zemion closed this issue

2026-07-08 20:59:37 +02:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: add-ideas/govoplan-core#206