Skip to content

Replace outdated "never patch" guidance in the usage guide #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsghi merged 1 commit into from
Oct 5, 2026
Merged

Replace outdated "never patch" guidance in the usage guide #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/seed/ref-devbrain-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,4 @@ Yes — fully. Cosmos DB is the backing store, not in-memory. Documents survive
Cosmos DB has a 2MB per-document limit. Typical sprint specs (15-30KB) and state documents (up to ~40KB) are well within this limit.

### Are documents versioned?
No. UpsertDocument is full overwrite semantics — there is no history. The `updatedAt` field tracks the last write time but previous versions are not retained. Be deliberate about overwrites. Never patch — always do full rewrites of the current content.
No. UpsertDocument is full overwrite semantics — there is no history. The `updatedAt` field tracks the last write time but previous versions are not retained, so be deliberate about overwrites. Use the narrowest write for the change: `PreviewEditDocument` / `ApplyEditDocument` for exact text edits, `AppendDocument` to add entries to a growing log (session history, decision logs), `EditTags` for tag-only changes, and `UpsertDocument` only when you mean to replace the whole document.
Loading