Repository navigation
Replace outdated "never patch" guidance in the usage guide - #28
Merged
Merged
Conversation
The FAQ still told assistants to "never patch — always do full rewrites", which predates PreviewEditDocument/ApplyEditDocument, AppendDocument, and EditTags and contradicts the guide's own preview/apply section. Point to the narrowest write for each kind of change instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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 FAQ at the end of
docs/seed/ref-devbrain-usage.mdstill said:That guidance predates
PreviewEditDocument/ApplyEditDocument,AppendDocument, andEditTags. It also contradicts the guide's own "Editing Existing Documents Safely — Preview and Apply" section, so an assistant following it would re-emit whole documents for small changes.The FAQ answer now keeps the "no versioning, be deliberate about overwrites" warning and points to the narrowest write for each kind of change:
PreviewEditDocument/ApplyEditDocumentAppendDocumentEditTagsUpsertDocumentThis is a docs-only change with no changelog entry. Instances that already seeded
ref:devbrain-usagecan re-seed it, or apply the same one-line change with preview/apply.🤖 Generated with Claude Code