Joe/docs update check work - #942
Open
joe-clickhouse wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The PR Adds docs drift check on pull requests as an advisory CI check that flags PRs that change user facing code without updating
docs/orREADME.md.The new docs_drift_check.yml workflow calls the shared claude-docs-drift workflow in
integrations-shared-workflows. Claude reads the PR diff and applies the rubric in the repo's own.claude/agents/docs-drift-reviewer.mdin report onlymode. When a user visible change is missing a doc update, the workflow applies the
needs-docslabel and posts one sticky comment naming the change and where the update belongs. Every push re-runs the check. Once the docsare updated the label is removed and the comment is marked resolved.
The check never blocks a merge. Fork PRs are skipped and a maintainer can run one manually via
workflow_dispatchwith the PR number.This is separate from
docs_sync.yml, which shipsdocs/to the aggregator repo, anddocs_verify.yml, which validates the Mintlify build. This check catches code changes that land without their matching doc updates.The rubric also works locally as a Claude Code agent in fix mode, where it edits the docs instead of only reporting.
Depends on the
claude-docs-driftworkflow PR inintegrations-shared-workflows.