ci: notify the docs portal after deploy

[pratyush618]

docs.byteveda.org/dagron/ is a mirror of this repo's docs build, pulled by the portal in ByteVeda/byteveda.site. Until now the portal only rebuilt on its daily cron, so a docs publish here could sit unmirrored for nearly a day. ByteVeda/byteveda.site#296 added a tool-docs-published repository_dispatch trigger; this PR sends that event from the deploy job, immediately after Pages goes live.

The run_id in the payload is the part worth reading twice. At the moment this step runs, the run is still in progress, so the portal's gh run list --status success lookup cannot see it and would mirror the previous build — the deploy would look like it had done nothing. Passing the id lets the portal pin this slug to this run. The docs-dist artifact is uploaded back in the build job, so it is already downloadable by then.

Requires the org secret DOCS_DISPATCH_TOKEN (Contents: read/write on ByteVeda/byteveda.site only), which is already configured for this repo. If the dispatch ever fails — rotated token, revoked access — this step goes red while Pages itself stays published, since the deploy step ran before it; the portal's daily cron is the fallback in that case.

Summary by CodeRabbit

• Documentation
  • Documentation publishing now automatically notifies the associated documentation site after a successful release.
  • This helps keep published documentation synchronized across platforms with less delay.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 13e4482b-8932-403a-88fb-556682a41442

📥 Commits

Reviewing files that changed from the base of the PR and between 897886a and 94dc1d0.

📒 Files selected for processing (1)

• .github/workflows/docs.yml

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• ByteVeda/taskito (manual) → reviewed against open PR #875 ci/notify-docs-portal instead of the default branch

Included review availability: 1 review is currently available. Your included PR review attempts over the past 7 days set your current allowance at 4 reviews per hour.

---

📝 Walkthrough

Walkthrough

The documentation deployment workflow now sends a tool-docs-published repository dispatch to ByteVeda/byteveda.site after publishing GitHub Pages.

Changes

Documentation publication

Layer / File(s)	Summary
Post-deployment portal dispatch .github/workflows/docs.yml	The deploy job calls the GitHub API after publication. The dispatch includes the dagron slug and current workflow run ID. The request uses DOCS_DISPATCH_TOKEN.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 94dc1

The deployment workflow now notifies the portal after publishing documentation. No actionable merge-blocking risk is established in the supplied change context.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: notifying the docs portal after the documentation deployment completes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

_{Comment @coderabbitai help to get the list of available commands.}