Skip to content

Render the HITL review workflow as a Mermaid diagram - #74024

Merged
kaxil merged 1 commit into
apache:mainfrom
astronomer:hitl-review-mermaid-diagram
Oct 1, 2026
Merged

kaxil merged 1 commit into
apache:mainfrom
astronomer:hitl-review-mermaid-diagram

Conversation

@Lee-W

@Lee-W Lee-W commented Oct 1, 2026 •

Copy link
Copy Markdown
Member

The sequence diagram was hand-drawn as a fixed-width ASCII code-block, which is hard to scan and easy to let drift from the actual control flow. The docs build already ships sphinxcontrib.mermaid (used by the provider ERD pages), so render it instead.

A single sequence diagram covering both the message exchange and the five-way outcome branch read as more cluttered than the original text, so split it in two: a sequence diagram for the poll/respond exchange, and a flowchart for what the operator does once it reads an action.

Before
image

After
image


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: [Claude] following the guidelines


  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

The sequence diagram was hand-drawn as a fixed-width ASCII `code-block`,
which is hard to scan and easy to let drift from the actual control
flow. The docs build already ships `sphinxcontrib.mermaid` (used by the
provider ERD pages), so render it instead.

A single sequence diagram covering both the message exchange and the
five-way outcome branch read as more cluttered than the original text,
so split it in two: a sequence diagram for the poll/respond exchange,
and a flowchart for what the operator does once it reads an action.
@kaxil
kaxil merged commit c19faf0 into apache:main Oct 1, 2026
68 of 69 checks passed
@kaxil
kaxil deleted the hitl-review-mermaid-diagram branch October 1, 2026 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants