docs: README diagram of the download / directory dispatch chain#312
docs: README diagram of the download / directory dispatch chain#312igorpecovnik wants to merge 1 commit into
Conversation
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.
|
Warning Rate limit exceeded
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 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. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
Add a Mermaid flowchart to the README showing how a fresh release ripples through the automation across
armbian/sdk→armbian/armbian.github.io→armbian/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-dispatchacross repos. One picture in the README makes the live-vs-suppressed picture explicit:GITHUB_TOKENsame-repo guard. Calls out that the suppression is load-bearing — without it,redirector ↔ download-indexwould loop forever.Web: Directory listingproducers that are alsoGITHUB_TOKEN-suppressed, so readers don't expect them to drivegenerate-web-directorydirectly (the data-branch push trigger does).Test plan