Skip to main content

Document Approval Workflow Documentation

This document is auto-generated from the code. Do not edit manually. To update this document, run yarn workspace @adamondo/backend generate:docs.

State Diagram​

Statuses​

  • pending: Document submitted and waiting for admin review.
  • changesRequested: Admin requested changes from the owner.
  • approved: Admin approved the document.

Actions Logic​

The workflow is driven by actors (Owner and Admin) performing actions that trigger state transitions.

Actions By Status​

This section describes what each actor can do for each document status.

Status: pending​

Actor: Admin​

  • Actions:
    • requestChanges
      • Label: requestChanges
      • Type: primary
    • approve
      • Label: approve
      • Type: primary

Status: changesRequested​

Actor: Owner​

  • Actions:
    • resubmit
      • Label: resubmit
      • Type: primary

Status: approved​

Actor: Owner​

  • Actions:
    • submit
      • Label: submit
      • Type: primary