beads/docs
Jim Wordelman 54dd4da670
docs(recovery): init-safety re-clone playbook covers damaged-store and fresh-clone gotchas (#6431)
* test(docs): red — Docs: init-safety re-clone playbook must say damaged stores go OUTSIDE data_dir and a fresh clone needs bd migrate schema (refs be-wv0d0)

* feat: green — Docs: init-safety re-clone playbook must say damaged stores go OUTSIDE data_dir and a fresh clone needs bd migrate schema (refs be-wv0d0)

- docs/recovery/init-safety.md: new re-clone-gotchas section covering both
  live gotchas from ga-vrq5pu (damaged/set-aside stores must move OUTSIDE
  data_dir; a fresh clone needs `bd migrate schema` for dolt-ignored
  clone-local tables), with cross-reference pointers from the two existing
  bd bootstrap mentions and a pointer (not a duplication) to bd doctor
  --fix's automated corrupt-manifest convention. Freshness markers bumped.
- cmd/bd/init_safety_help.go: RECOVERY section of the init-safety Long help
  gets a brief RE-CLONE GOTCHAS addendum with both symptom signatures and
  the fix command.
- test/docsync/init_safety_recovery_test.go: retargeted
  TestInitSafetyCLIReferenceCoversReCloneGotchas (written during RED) to
  TestInitSafetyCLIHelpCoversReCloneGotchas, asserting on
  cmd/bd/init_safety_help.go's Long field instead of the generated
  docs/cli-reference/init-safety.md. That generated page is pinned to a
  released bd (docs/cli-docs.pin = v1.2.2, built in a detached worktree per
  scripts/resolve-docs-bd.sh) and does not pick up a Long-field edit at
  HEAD until a maintainer bumps the pin at the next release — confirmed
  empirically (`git show v1.2.2:cmd/bd/init_safety_help.go` still points at
  the deprecated docs/RECOVERY.md path, and a full
  ./scripts/generate-cli-docs.sh run here produced zero diff to the
  committed docs/cli-reference/). CI's own drift gate
  (scripts/check-cli-docs-drift.sh) is blame-scoped for exactly this
  reason. The original RED test was asserting on an artifact this PR
  cannot legitimately change without fighting that pin.

* fix(docs): address review feedback on init-safety re-clone playbook

Three fixes per bee-ghosttrack's REQUEST-CHANGES on PR #6431:

- Correct Gotcha 1's "The fix" paragraph: bd doctor --fix's
  corrupt-manifest repair renames the whole data_dir directory to a
  sibling .<ts>.corrupt.backup path, not a backup nested inside the
  database's own directory. Verified against
  cmd/bd/doctor/fix/database_integrity.go and
  cmd/bd/doctor/tracked_runtime.go.

- Replace the hardcoded "Schema already at v64" literal with
  version-agnostic "Schema already at v<N>" in the doc and CLI help
  text, and narrow the docsync test assertion to the prefix "schema
  already at v" so it survives future version bumps instead of
  rotting again.

- Drop the dead GitHub-issue-style link around ga-vrq5pu (a Gas City
  bead id, not a GitHub issue) — keep it as plain text.

Ref: be-hobyw

* review: correct re-clone gotchas and tighten their guards (PR #6431 iters 1-2)

Maintainer review fixup for the adopted PR. This is a docs-only PR whose
entire deliverable is factual accuracy, so every finding here is about a
claim the doc makes rather than about code behaviour.

=== Iteration 1 ===

[major] Gotcha 1's "The fix" paragraph misattributed the automated repair
and pointed an operator mid-crash-loop at a path that cannot run. Verified
first-hand in the worktree:

  - internal/doltserver/manifest_recovery.go:231-235 renames
    <data_dir>/<db>/.dolt -> <db>/.dolt.<ts>.corrupt.backup, i.e. IN PLACE,
    not the whole data_dir to a sibling as the doc claimed. It also only
    fires behind nomsDirLooksCorrupt, whose own comment is "recovery only
    fires when we can prove there is nothing the user would want to keep"
    (:94-100) - so it never touches the superseded-but-populated store the
    gotcha is about.
  - The whole-data_dir -> sibling rename is a different fix:
    cmd/bd/doctor/fix/database_integrity.go:35,43-45 over
    getDatabasePath(beadsDir) (validation.go:15-21).
  - That fix opens with serverModeIntegrityRecoveryGuard, which refuses
    outright in Dolt server mode (:79-96).

Rewritten to state all three facts and to tell the reader plainly that the
move is theirs to make by hand. Kept the correct headline sentence. The
paragraph deliberately does not assert anything about where the in-place
backup lands under the legacy single-database layout (data_dir/.dolt), the
one premise the review left unproven - the wording is scoped to the standard
<data_dir>/<db>/ layout instead of minting a fresh unverified claim.

[minor] Gotcha 2's mechanism sentence ("bd's ordinary open does not recreate
them") is false for embedded mode: newStore -> initSchema (store.go:285,470)
calls schema.MigrateUp (:574), and migrationWorkNeeded returns true whenever
!ignoredSource.atLatest (schema.go:866-867) - and ignored_schema_migrations
is itself in doltIgnorePatterns, so a fresh clone always qualifies. Replaced
the universal with the actual condition. The replacement list of opens that
do NOT self-heal was itself wrong on its first item; see iteration 2 below.
The prescribed remedy was already correct and is unchanged.

[minor] The doc's prose Freshness source list gained cmd/bd/init_safety_help.go
but the enforcing DOCS array did not. Added to both scripts/check-doc-freshness.sh
and the pinned row in scripts/check_doc_freshness_test.go - a coupled pair:
editing only the script reds the pinned test with "Freshness source does not
name cmd/bd/init_safety_help.go" (verified by running exactly that mutation).

[nit] The docsync guard for the headline rule was two independent whole-file
substring checks. Scoped it to Gotcha 1's own section and matched the advice
as a phrase, and pinned both ends of the help text's #re-clone-gotchas
cross-reference, which neither markdown link checker can see because it lives
in a Go string. Five mutation legs, each reddening only its own assertion:
inverting the advice, moving the phrase outside the section, renaming the
heading, breaking the help anchor, and removing the Gotcha 1 heading. The
inversion leg is the one that matters - the file still contained "outside"
(2x) and "data_dir" (13x), so the old form stayed green on inverted advice.

[nit] Bumped Last reviewed: to the revision date.

=== Iteration 2 ===

Both lanes verified all five iteration-1 fixes. Three prose findings remained,
none a merge gate (scorecard: approve, Required Changes: none). All three are
the same defect class - a sentence that quantifies over a set the author did
not census - so each is fixed by removing the quantifier rather than by
restating it more carefully.

[minor] Gotcha 2's replacement enumeration was false on its first item: a
server, shared or proxied open DOES replay the clone-local series in this
doc's own scenario. Re-derived at head, both lanes independently:

  - internal/storage/uow/dolt_sql_provider.go:267-287 calls
    MigrateUpWithLock UNCONDITIONALLY on the non-team-server, non-preview
    arm; p.readOnly is consulted only after a RemoteMigrateGateError comes
    back (:288-296), so it cannot suppress the pass.
  - The gate cannot refuse a main-current clone: PendingVersions is
    mainSource.pendingVersions only (schema.go:525-527) and the gate
    early-returns nil on len(pending)==0 (remote_migrate_gate.go:731-737),
    so the ignored series is invisible to it.
  - migrationWorkNeeded is true whenever !ignoredSource.atLatest
    (schema.go:866-869), so the locked pass runs the full MigrateUp
    including ignoredSource.migrate (schema.go:822). DoltStore.initSchema
    reaches the same call on the writable-open path (dolt/store.go:3076).

So the positive clause is widened to any writable open (embedded, server or
proxied), and the negative clause is rewritten as a tautology plus an open
list: the open that hit the error was not self-healing, and the kinds that
skip or only verify "include" read-only/preview opens, team-server opens
(verifyTeamServerSchema only checks - dolt_sql_provider.go:342-371), the
preview-attach arm, and gate-refused opens. Each named arm was verified
individually; the list deliberately does not claim to be exhaustive, which
is what the previous wording got wrong. Nothing in docsync can enforce this
paragraph, so an open list is also the honest shape.

[minor] Gotcha 1's data_dir locator omitted the mode that overrides both
knobs it names. ResolveDoltDir checks IsSharedServerMode() FIRST and returns
SharedDoltDir() before it ever reaches projectDoltDirPath
(doltserver.go:316-330); the knobs are BEADS_DOLT_SHARED_SERVER=1|true or the
dolt.shared-server config key (:117-122), and the directory is
~/.beads/shared-server/dolt/, overridable via BEADS_SHARED_SERVER_DIR
(:248-257, :275-285). Added as its own paragraph rather than growing the
parenthetical, with the reason it matters most there: one shared data_dir
holds every project's database, so a single stray subdirectory crash-loops
the server for all of them.

[nit] "neither of bd doctor --fix's TWO Dolt-database repairs" made a numeric
claim the sentence does not need, and the count is wrong:
cmd/bd/doctor/fix/repo_fingerprint.go:135-161 os.RemoveAll's
cfg.DatabasePath(beadsDir) behind an interactive "This will DELETE %s. [y/N]",
and cleanCruftBeadsDirFiles (artifacts.go:238) can remove a .beads
subdirectory too when a redirect is expected. Dropping the word "two" would
have left "neither", which is itself a two-quantifier, so the count is
removed instead: "no bd doctor --fix repair performs this move here. The two
that come closest are:" - now a statement about the two bullets that follow,
not a census of the repairs. The operative universal survives the census
(the move-performing rename sites are only database_integrity.go:46,54; the
others delete or rename in place), so the reader's action is unchanged.

Validation (iteration 2): go test -tags=gms_pure_go ./test/docsync (8 tests,
green, zero skips, both InitSafety tests among them); go test -tags=integration
-count=1 -run Freshness ./scripts (33 pass, 1 Windows-only skip);
./scripts/check-doc-freshness.sh PASS with docs/recovery/init-safety.md at 0
days old and all five of its Freshness sources resolving; git diff --check
clean. Prose-only: no code, test or freshness-pair file changed this
iteration.

---------

Co-authored-by: Julian Knutsen <julianknutsen@users.noreply.github.com>
2026-09-27 03:41:05 -07:00
..
architecture fix(gc): flatten/compact run full GC after the rewrite; bd gc --full; low-reclaim hint (#5907) (#6057) 2026-08-29 05:19:06 +00:00
cli-reference docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876) 2026-07-17 18:03:28 -07:00
core-concepts docs: supersedes is a replacement link, not a version chain (#6212) 2026-09-12 06:41:33 -07:00
diagrams docs: port the Excalidraw diagram pipeline (machinery only) 2026-07-12 10:37:17 -07:00
getting-started fix(schema,docs): make the shared data-behind consent step runnable (#6692) 2026-09-23 05:46:48 -07:00
images docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00
integrations docs: document ado.reconcile_interval and inventory every storage span 2026-08-07 21:20:41 +00:00
multi-agent fix(reclaim): correct the heartbeat re-home invariant's scope in the new docs (wy-sp2l4) 2026-08-13 04:30:30 -07:00
recovery docs(recovery): init-safety re-clone playbook covers damaged-store and fresh-clone gotchas (#6431) 2026-09-27 03:41:05 -07:00
reference Accept uutils coreutils timeout in generated hooks, and check the shims against real implementations (#6561) 2026-09-27 03:38:45 -07:00
workflows docs(gates): document multi-rig/proxied gate limitations for 1.3.0 (#6052) 2026-08-28 23:23:15 -07:00
cli-docs.pin chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
CLI_REFERENCE.md docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876) 2026-07-17 18:03:28 -07:00
community-tools.md docs: add Maggie to community tools (#6446) 2026-09-26 19:12:59 -07:00
docs.json chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
index.md release: prep v1.3.0 — version bump, changelog rollup, release process docs, formula fixes (#6038) 2026-08-30 22:19:35 -07:00
RECOVERY.md docs(recovery): reduce the stub to a pure pointer 2026-07-17 18:56:33 -07:00
related-projects.md docs: apply PR #4722 review feedback to user docs 2026-07-12 11:06:57 -07:00