feat: explain configured institutional architecture
This commit is contained in:
@@ -55,6 +55,21 @@ Frontend package:
|
||||
|
||||
Platform module manifests, configuration packages, release catalogs, and governance rules are documented in `govoplan-core/docs/`.
|
||||
|
||||
Every module manifest must contribute a static documentation baseline for both
|
||||
the `user` and `admin` projections through `ModuleManifest.documentation`.
|
||||
Runtime providers may add actor- and configuration-specific detail, but they do
|
||||
not replace that baseline. A behavior change is complete only when the owning
|
||||
module updates the affected workflows, settings, permissions, limitations, and
|
||||
operational consequences. Validate workspace coverage with:
|
||||
|
||||
```sh
|
||||
cd /mnt/DATA/git/govoplan
|
||||
./tools/checks/check-manifest-shapes.py
|
||||
```
|
||||
|
||||
Feature content remains in the owning module. Docs indexes and renders the
|
||||
contributions without importing feature implementations.
|
||||
|
||||
Capabilities can provide generic documentation without exposing their runtime
|
||||
provider implementation:
|
||||
|
||||
@@ -79,6 +94,13 @@ freshness, provenance, descriptions, and package requirements remain visible
|
||||
as typed evidence; provider objects, credentials, and secret configuration are
|
||||
never imported into the Docs WebUI.
|
||||
|
||||
Module-owned external-provider runtime state is also projected through the
|
||||
Core contract. Administrative documentation may show sanitized binding-level
|
||||
state; ordinary-user documentation receives only aggregate configured, active,
|
||||
authority, health, freshness, conflict, recovery, and observation fields.
|
||||
URLs, credential references, provider error text, and binding identifiers are
|
||||
excluded from the user projection.
|
||||
|
||||
## Concept documents
|
||||
|
||||
- `docs/DOCUMENTATION_LAYER_CONCEPT.md` defines the configured, available, and evidence documentation model.
|
||||
|
||||
Reference in New Issue
Block a user