docs: Add AGENTS sync script#299
Merged
ericholscher merged 1 commit intomainfrom May 1, 2026
Merged
Conversation
Merged
stsewd
approved these changes
May 1, 2026
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
2 participants
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.
Adds a helper script for syncing this repo's
AGENTS.mdinto allowed sibling Read the Docs repositories that already have one.The script defaults to a dry run, supports
--applyfor copying, committing, and pushing, and skips repositories with missingAGENTS.mdfiles or dirty tracked changes.Validation:
uvx --python 3.12 pre-commit run --config pre-commit-config.yaml --files sync-agents.shfailed because the shared Vale hook looks for/Users/eric/projects/common/docs/vale, which does not exist in this repo.env SKIP=vale uvx --python 3.12 pre-commit run --config pre-commit-config.yaml --files sync-agents.shpassed.bash -n sync-agents.shpassed.Generated by the AI agent in use.