From 4ca65351ca6894367e11c4751a255c5e42f78aad Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Sat, 22 Aug 2026 07:55:19 +0200 Subject: [PATCH] docs: complete public documentation baseline --- package.json | 2 +- pyproject.toml | 2 +- src/govoplan_grants/backend/manifest.py | 13 ++++++++++++- tests/test_manifest.py | 9 +++++++++ 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 9c53ea0..3a65b45 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@govoplan/grants", - "version": "0.1.18", + "version": "0.1.19", "private": true, "description": "GovOPlaN Grants platform module seed.", "type": "module", diff --git a/pyproject.toml b/pyproject.toml index 73350b4..da83d6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "govoplan-grants" -version = "0.1.18" +version = "0.1.19" description = "GovOPlaN Grants platform module seed." readme = "README.md" requires-python = ">=3.12" diff --git a/src/govoplan_grants/backend/manifest.py b/src/govoplan_grants/backend/manifest.py index f179ee2..09cee19 100644 --- a/src/govoplan_grants/backend/manifest.py +++ b/src/govoplan_grants/backend/manifest.py @@ -6,7 +6,7 @@ from govoplan_core.core.provider_governance import declared_module_architecture MODULE_ID = "grants" MODULE_NAME = "Grants" -MODULE_VERSION = "0.1.18" +MODULE_VERSION = "0.1.19" READ_SCOPE = "grants:workspace:read" WRITE_SCOPE = "grants:workspace:write" ADMIN_SCOPE = "grants:workspace:admin" @@ -69,6 +69,13 @@ DOCUMENTATION = ( layer="available", documentation_types=("admin", "user"), audience=("user", "operator", "module_admin", "product_owner"), + translations={ + "de": { + "title": "Modulgrenze von Grants", + "summary": "Förderprogrammabläufe für Anträge, Förderfähigkeit, Bewilligungen, Meilensteine, Auszahlungsanforderungen, Berichtspflichten und Prüfungen.", + "body": "Dieses Repository ist derzeit ein Grundgerüst für ein Plattformmodul. Es registriert die Fachgrenze, Berechtigungsoberfläche, Rollenvorlagen und Dokumentationsmetadaten, bevor Laufzeit-APIs, Datenbankmodelle, Migrationen und WebUI-Routen eingeführt werden.", + } + }, order=100, related_modules=OPTIONAL_DEPENDENCIES, links=( @@ -79,7 +86,11 @@ DOCUMENTATION = ( ), ), metadata={ + "kind": "reference", "seed": True, + "consequence_classes": { + "seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.", + }, "domain_objects": ['funding programs', 'grant applications', 'eligibility checks', 'award records', 'milestones', 'payout claims', 'reporting duties'], "first_slice": "Define funding program, application, eligibility, award, milestone, payout claim, and reporting-duty records.", }, diff --git a/tests/test_manifest.py b/tests/test_manifest.py index 4c5cf87..87707bc 100644 --- a/tests/test_manifest.py +++ b/tests/test_manifest.py @@ -15,6 +15,15 @@ class ManifestSeedTests(unittest.TestCase): self.assertEqual({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE}) self.assertEqual({role.slug for role in manifest.role_templates}, {"grants_manager", "grants_viewer"}) self.assertTrue(manifest.documentation) + topic = manifest.documentation[0] + self.assertEqual("reference", topic.metadata["kind"]) + self.assertIn("seed_boundary", topic.metadata["consequence_classes"]) + self.assertTrue( + all( + topic.translations.get("de", {}).get(field) + for field in ("title", "summary", "body") + ) + ) self.assertIsNone(manifest.route_factory) self.assertIsNone(manifest.migration_spec) self.assertIsNone(manifest.frontend)