Skip to content

[codex] dispatch docs sync for api changes#316

Merged
RtlZeroMemory merged 1 commit intomainfrom
codex/update-docs-dispatch
Apr 3, 2026
Merged

[codex] dispatch docs sync for api changes#316
RtlZeroMemory merged 1 commit intomainfrom
codex/update-docs-dispatch

Conversation

@RtlZeroMemory
Copy link
Copy Markdown
Owner

@RtlZeroMemory RtlZeroMemory commented Apr 3, 2026

Summary

  • broaden the docs-dispatch workflow triggers beyond docs/** and mkdocs.yml
  • include package, TypeDoc, and docs-build script changes so the website API reference stays in sync automatically
  • document that the website repo now syncs directly to main without opening a PR

Why

The website sync now regenerates and publishes public/api/reference directly on rezitui.dev. Restricting dispatches to only docs content meant API-surface changes in packages/** or TypeDoc config changes would not trigger a website sync, leaving the hosted API reference stale.

Summary by CodeRabbit

  • Chores
    • Updated documentation workflow to trigger when package files, build configuration, and related scripts are modified, ensuring documentation stays synchronized with code and dependency changes.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 3, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5605ed5e-266d-4436-94f8-881f4b31258a

📥 Commits

Reviewing files that changed from the base of the PR and between 16615a0 and 08aaf38.

📒 Files selected for processing (1)
  • .github/workflows/docs-dispatch.yml

📝 Walkthrough

Walkthrough

The docs-dispatch workflow trigger conditions were expanded to include additional files beyond documentation. Previously triggered only on docs/** and mkdocs.yml changes, it now also dispatches when packages/**, typedoc.json, package.json, package-lock.json, or scripts/docs.sh are modified.

Changes

Cohort / File(s) Summary
Workflow Configuration
.github/workflows/docs-dispatch.yml
Expanded workflow trigger paths to include package dependencies, configuration files, and documentation script in addition to existing documentation file patterns.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit's delight, the workflow now sees,
When packages dance and deps change with ease,
The docs shall dispatch, a automated cheer,
For every config tweak and script update dear! 📜✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/update-docs-dispatch

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

@RtlZeroMemory RtlZeroMemory merged commit b82fabd into main Apr 3, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant