Skip to content

Add docs notification workflow for mintlify-omni#30

Merged
jacksweeney5 merged 1 commit into
mainfrom
jack/readme-docs-syncing
Apr 9, 2026
Merged

Add docs notification workflow for mintlify-omni#30
jacksweeney5 merged 1 commit into
mainfrom
jack/readme-docs-syncing

Conversation

@jacksweeney5
Copy link
Copy Markdown
Contributor

@jacksweeney5 jacksweeney5 commented Apr 9, 2026

Summary

  • Adds notify-docs.yml workflow that dispatches cli-docs-update events to exploreomni/mintlify-omni
  • Triggers on release published AND when markdown files change on main
  • Enables automated downstream documentation sync

How it works

CLI README changes on main (or release published)
  → notify-docs.yml fires repository_dispatch to mintlify-omni
  → mintlify-omni/sync-upstream-docs.yml processes the change
  → Claude Code analyzes diff, updates MDX docs, creates PR
  → /review comment triggers automated doc review

Secrets required

  • DOCS_REPO_TOKEN — fine-grained PAT (write-to-mintlify-omni) with Contents: Read and write, scoped to exploreomni/mintlify-omni only

Related PRs

Test plan

  • Configure DOCS_REPO_TOKEN secret with fine-grained PAT
  • Merge receiver PR in mintlify-omni first
  • Push a README change to main and verify dispatch fires
  • Verify mintlify-omni creates a docs sync PR

🤖 Generated with Claude Code

Dispatches cli-docs-update events to exploreomni/mintlify-omni when
markdown files change on main or a release is published, enabling
automated downstream documentation sync.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jacksweeney5 jacksweeney5 merged commit 1e2c4a1 into main Apr 9, 2026
2 checks passed
@jacksweeney5 jacksweeney5 deleted the jack/readme-docs-syncing branch April 9, 2026 23:03
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.

2 participants