Document how a sync PR differs from an off-target direct edit#417
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds reviewer-facing guidance to AGENTS.md clarifying how to distinguish sanctioned documentation sync PRs from off-target hand-edits, reducing false-positive review feedback in this docs-mirror repository.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Changes:
- Document that docs changes are expected to arrive via
script/api/sync_to_bc3_apisync PRs (and how to recognize them via the PR description footer). - Define “off-target edits” and call out the exception for repo-local files/GitHub metadata that are not copied by the sync.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jeremy
force-pushed
the
document-sync-pr-vs-direct-edit
branch
from
July 23, 2026 04:55
0a8158f to
7d3f0b3
Compare
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.
Automated reviewers keep flagging legitimate sync PRs as unauthorized direct edits to
sections/— because a sync PR and a hand-edit look identical in the diff, and AGENTS.md only said "don't edit docs here" without carving out that syncs are the sanctioned path.This adds a short Sync PRs are expected — off-target edits are not subsection that:
README.md,CONDUCT.md, or asections/*.mdfile is sync output fromscript/api/sync_to_bc3_api— the only way that content changes — so reviewers should read the docs on their merits, not flag the mechanism.Synced from bc3 doc/api/ …footer in their description; an off-target edit has no footer and won't match bc3'sdoc/api/.Docs/guidance only.