Skip to content

Commit

Permalink
Add module level doc
Browse files Browse the repository at this point in the history
  • Loading branch information
theskumar authored and frjo committed Jan 10, 2025
1 parent 9b48af1 commit 268ecec
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions hypha/apply/funds/workflows/__init__.py
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit 268ecec

Please sign in to comment.