docs: complete public documentation baseline
Module Package Release / publish-packages (push) Successful in 10s

This commit is contained in:
2026-08-22 07:55:18 +02:00
parent 4f4122d574
commit 13131f82cd
4 changed files with 23 additions and 3 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/facilities", "name": "@govoplan/facilities",
"version": "0.1.18", "version": "0.1.19",
"private": true, "private": true,
"description": "GovOPlaN Facilities platform module seed.", "description": "GovOPlaN Facilities platform module seed.",
"type": "module", "type": "module",
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-facilities" name = "govoplan-facilities"
version = "0.1.18" version = "0.1.19"
description = "GovOPlaN Facilities platform module seed." description = "GovOPlaN Facilities platform module seed."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
+12 -1
View File
@@ -6,7 +6,7 @@ from govoplan_core.core.provider_governance import declared_module_architecture
MODULE_ID = "facilities" MODULE_ID = "facilities"
MODULE_NAME = "Facilities" MODULE_NAME = "Facilities"
MODULE_VERSION = "0.1.18" MODULE_VERSION = "0.1.19"
READ_SCOPE = "facilities:workspace:read" READ_SCOPE = "facilities:workspace:read"
WRITE_SCOPE = "facilities:workspace:write" WRITE_SCOPE = "facilities:workspace:write"
ADMIN_SCOPE = "facilities:workspace:admin" ADMIN_SCOPE = "facilities:workspace:admin"
@@ -69,6 +69,13 @@ DOCUMENTATION = (
layer="available", layer="available",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("user", "operator", "module_admin", "product_owner"), audience=("user", "operator", "module_admin", "product_owner"),
translations={
"de": {
"title": "Modulgrenze von Facilities",
"summary": "Gebäudemanagement für Gebäude, Räume, Wartung, Reinigung, Schlüssel, Zutrittszonen, wiederkehrende Prüfungen, Belegung, Mängel und Dienstleistungsunternehmen.",
"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, order=100,
related_modules=OPTIONAL_DEPENDENCIES, related_modules=OPTIONAL_DEPENDENCIES,
links=( links=(
@@ -79,7 +86,11 @@ DOCUMENTATION = (
), ),
), ),
metadata={ metadata={
"kind": "reference",
"seed": True, "seed": True,
"consequence_classes": {
"seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.",
},
"domain_objects": ['building and room operations', 'maintenance and cleaning schedules', 'key and access-zone facts', 'occupancy metadata', 'defect records', 'contractor references'], "domain_objects": ['building and room operations', 'maintenance and cleaning schedules', 'key and access-zone facts', 'occupancy metadata', 'defect records', 'contractor references'],
"first_slice": "Create building, room, maintenance block, defect, contractor, and inspection link concepts with clear resource and asset boundaries.", "first_slice": "Create building, room, maintenance block, defect, contractor, and inspection link concepts with clear resource and asset boundaries.",
}, },
+9
View File
@@ -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({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE})
self.assertEqual({role.slug for role in manifest.role_templates}, {"facilities_manager", "facilities_viewer"}) self.assertEqual({role.slug for role in manifest.role_templates}, {"facilities_manager", "facilities_viewer"})
self.assertTrue(manifest.documentation) 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.route_factory)
self.assertIsNone(manifest.migration_spec) self.assertIsNone(manifest.migration_spec)
self.assertIsNone(manifest.frontend) self.assertIsNone(manifest.frontend)