Uh oh!
There was an error while loading. Please reload this page.
docs: add File-Write Safety feature guide (upstream epic #1375) - #49
Open
easonLiangWorldedtech wants to merge 1 commit into
Open
docs: add File-Write Safety feature guide (upstream epic #1375)#49easonLiangWorldedtech wants to merge 1 commit into
easonLiangWorldedtech wants to merge 1 commit into
Conversation
New page covering the guarded write path (observed vs unobserved writes, the four rejection messages), per-write checkpoints, per-step change cards, rollback, and the checkpoints settings. Wires the page into the sidebar, the features index, the chat interface guide (change cards), the checkpoints config list, and the apply-patch / edit-file / edit / write-to-file tool reference pages. Includes four screenshots (summary + full change cards, rollback state, checkpoints settings).
easonLiangWorldedtech
requested review from
JamesRobert20, edelauna, hannesrudolph, navedmerchant and taltas
as code ownersAugust 28, 2026 02:16
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 freeto 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.
Docs: File-Write Safety feature guide (upstream epic #1375)
Adds the user-facing documentation for the file-write safety series: how a write is guarded, when it is rejected and what the remediation means, per-write checkpoints, per-step change cards, rollback, and the related settings. Mirrors the DTE-style docs PR: one self-contained page, wired into the sidebar, with screenshots.
New pages
docs/features/file-write-safety.md): how a write is guarded (observed vs unobserved), the four rejection messages and their meaning, per-write checkpoints, per-step change cards (summary/full), rollback (file and step), the checkpoints settings, the default write path, and where the data lives.Wiring
sidebars.ts:features/file-write-safetyadded afterfeatures/checkpoints.docs/features/index.md: File-Write Safety listed under Workflow Management.docs/basic-usage/the-chat-interface.md: new Change Cards section (what a card shows, per-file and per-step rollback).docs/features/checkpoints.mdx: per-write checkpoint bullet added to the configuration list.apply-patch.md,edit-file.md,edit.md,write-to-file.md): each gains a short Write safety section describing the guarded publish the tool goes through.Images
Four screenshots under
/img/file-write-safety/(exact component crops, light theme):change-card-summary.png— summary change cardchange-card-full.png— full (detailed) change cardrollback-state.png— change card in the rolled-back statesettings-checkpoints.png— checkpoints settings sectionVerification
pnpm buildpasses (Docusaurus production build, no new warnings beyond the pre-existing update-notice banners).Related code series: upstream epic Zoo-Code-Org/Zoo-Code#1375 (trial aggregate Zoo-Code-Org/Zoo-Code#1413).