feat: explain external work hand-offs
Module Package Release / publish-packages (push) Successful in 11s

This commit is contained in:
2026-08-22 02:14:35 +02:00
parent d5214c641c
commit 8e5415dfe7
4 changed files with 75 additions and 6 deletions
+45 -1
View File
@@ -2,6 +2,7 @@ from __future__ import annotations
from govoplan_core.core.modules import (
CapabilityDocumentation,
DocumentationCondition,
DocumentationLink,
DocumentationTopic,
FrontendModule,
@@ -34,7 +35,7 @@ from govoplan_workflow_engine.backend.manifest import (
MODULE_ID = "workflow"
MODULE_NAME = "Workflow"
MODULE_VERSION = "0.1.19"
MODULE_VERSION = "0.1.20"
SEMANTIC_SUBJECT_CAPABILITY = semantic_documentation_subject_capability(MODULE_ID)
@@ -139,6 +140,49 @@ manifest = ModuleManifest(
),
),
documentation=(
DocumentationTopic(
id="workflow.external-handoff-inspection",
title="Inspect and return to external work hand-offs",
summary=(
"Follow the exact linked module work while Workflow retains "
"its durable position and immutable reference."
),
body=(
"The runs dialog shows the current external hand-off state, exact "
"revision reference, safe linked-work action, timeout, and the "
"immutable Workflow evidence trail. Leaving the dialog or linked "
"Campaign page does not complete the step. Declared Campaign events "
"drive acceptance, reassignment, completion, rejection, and "
"cancellation without browser polling. A configured focused View "
"narrows the available surfaces while the step is active. If Views "
"is absent, the linked Campaign action remains available and the "
"dialog explains the reduced presentation. Missing optional Tasks or "
"Notifications is also shown without changing the hand-off outcome."
),
layer="available",
documentation_types=("admin", "user"),
audience=("operator", "workflow_designer", "campaign_manager"),
related_modules=(
"workflow_engine",
"campaigns",
"views",
"tasks",
"notifications",
),
conditions=(
DocumentationCondition(
any_scopes=(INSTANCE_READ_SCOPE, ADMIN_SCOPE),
),
),
metadata={
"kind": "workflow",
"help_contexts": [
"workflow.external-handoff",
"workflow.instances",
],
},
order=74,
),
DocumentationTopic(
id="workflow.semantic-documentation",
title="Document configured workflow and step meaning",