From 268ecec3d005c77b13c5c8763933a43284c9adf7 Mon Sep 17 00:00:00 2001 From: Saurabh Kumar Date: Sat, 4 Jan 2025 22:22:29 +0530 Subject: [PATCH] Add module level doc --- hypha/apply/funds/workflows/__init__.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/hypha/apply/funds/workflows/__init__.py b/hypha/apply/funds/workflows/__init__.py index 8dedfef3a2..b977034fcf 100644 --- a/hypha/apply/funds/workflows/__init__.py +++ b/hypha/apply/funds/workflows/__init__.py @@ -1,3 +1,21 @@ +""" +Workflow System Documentation + +This package implements a flexible workflow system for managing application states +and transitions. The system is built on the following key concepts: + +- Workflow: Overall process definition containing stages and phases +- Stage: Major sections of the workflow (e.g. Request, Proposal) +- Phase: Individual states within a stage +- Transition: Allowed movements between phases + +Key Components: +- models/: Core workflow model classes +- definitions/: Workflow configuration definitions +- registry.py: Central workflow registration and lookup +- permissions.py: Permission checking system +""" + from .constants import ( DETERMINATION_OUTCOMES, DRAFT_STATE,