From 897fd8fecccac79da09b2b62346aa2a0d10ee620 Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Sat, 1 Aug 2026 17:48:38 +0200 Subject: [PATCH] docs: declare institutional architecture boundary --- AGENTS.md | 6 ++++++ src/govoplan_permits/backend/manifest.py | 14 ++++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 5abc6f8..79dbb24 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,11 @@ # GovOPlaN Permits Codex Guide +## Documentation Contract + +- Treat documentation as part of every behavior change. Update this module's manifest-driven `DocumentationTopic` contributions for affected user and administrator behavior. +- Keep feature content here; `govoplan-docs` projects it without importing Permits internals. +- Maintain a static user/admin baseline and run `/mnt/DATA/git/govoplan/tools/checks/check-manifest-shapes.py` after behavior or manifest changes. + ## Scope This repository owns the GovOPlaN Permits platform module seed. diff --git a/src/govoplan_permits/backend/manifest.py b/src/govoplan_permits/backend/manifest.py index 5336e47..2d1de06 100644 --- a/src/govoplan_permits/backend/manifest.py +++ b/src/govoplan_permits/backend/manifest.py @@ -2,6 +2,7 @@ from __future__ import annotations from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate +from govoplan_core.core.provider_governance import declared_module_architecture MODULE_ID = "permits" MODULE_NAME = "Permits" @@ -66,8 +67,8 @@ DOCUMENTATION = ( "database models, migrations, and WebUI routes are introduced." ), layer="available", - documentation_types=("admin",), - audience=("operator", "module_admin", "product_owner"), + documentation_types=("admin", "user"), + audience=("user", "operator", "module_admin", "product_owner"), order=100, related_modules=OPTIONAL_DEPENDENCIES, links=( @@ -95,6 +96,15 @@ manifest = ModuleManifest( permissions=PERMISSIONS, role_templates=ROLE_TEMPLATES, documentation=DOCUMENTATION, + architecture=declared_module_architecture( + layer="domain_capability", + kind="domain", + maturity="scaffold", + documentation_ref="docs/PERMITS_DOMAIN_BOUNDARY.md", + known_limits=("Permit application, assessment, decision, and validity lifecycles are not implemented yet.",), + owned_concepts=("permit", "permit application", "permit condition"), + non_owned_concepts=("case", "formal decision", "payment"), + ), )