Skip to content

docs: README diagram of the download / directory dispatch chain#312

Open
igorpecovnik wants to merge 1 commit into
mainfrom
readme-dispatch-chain-diagram
Open

docs: README diagram of the download / directory dispatch chain#312
igorpecovnik wants to merge 1 commit into
mainfrom
readme-dispatch-chain-diagram

Conversation

@igorpecovnik
Copy link
Copy Markdown
Member

Summary

Add a Mermaid flowchart to the README showing how a fresh release ripples through the automation across armbian/sdkarmbian/armbian.github.ioarmbian/website. Mermaid renders natively in GitHub-flavoured markdown.

Why

Newcomers (and me, after a week away) keep having to reverse-engineer the dispatch chain by grepping for repository-dispatch across repos. One picture in the README makes the live-vs-suppressed picture explicit:

  • Solid arrows = dispatches that actually fire.
  • Dotted arrow = intentionally suppressed by GitHub's GITHUB_TOKEN same-repo guard. Calls out that the suppression is load-bearing — without it, redirector ↔ download-index would loop forever.
  • Footnote enumerates other Web: Directory listing producers that are also GITHUB_TOKEN-suppressed, so readers don't expect them to drive generate-web-directory directly (the data-branch push trigger does).

Test plan

  • Open the rendered README on GitHub; confirm the Mermaid diagram renders (not an inert code block).
  • Confirm node labels and edge labels are legible at default GitHub width.

Show how a release ripples through the automation: external triggers
(SDK build / manual / schedule) → download-index → redirector → data
branch pushes → directory regen → cross-repo website sync.

Mermaid renders natively on GitHub; solid arrows fire, dotted arrow is
the GITHUB_TOKEN-suppressed step that intentionally breaks what would
otherwise be a redirector ↔ download-index loop.

Footnote lists the other GITHUB_TOKEN-suppressed Web: Directory
listing dispatchers so readers understand why the directory regen
relies on the data-branch push trigger instead of those.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 10, 2026

Warning

Rate limit exceeded

@igorpecovnik has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 21 minutes and 26 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b58c42b6-e58e-4cae-8812-6bcbdc03d7f9

📥 Commits

Reviewing files that changed from the base of the PR and between 1e0c028 and 0d41eb8.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-dispatch-chain-diagram

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added 05 Milestone: Second quarter release size/small PR with less then 50 lines Needs review Seeking for review Documentation Documentation changes or additions labels May 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

05 Milestone: Second quarter release Documentation Documentation changes or additions Needs review Seeking for review size/small PR with less then 50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant