beads/docs/reference
Chris Sells 5c2fe0d496 docs: loss-check merge legacy docs/ originals into the site pages
Sixteen same-ground pairs reconciled: the ported website page won and every
fact living only in the older docs/ original was merged in before deleting
it (INSTALLING, SETUP, ARCHITECTURE, CONFIG, GIT_INTEGRATION, ADVANCED,
TROUBLESHOOTING, FAQ, MOLECULES, ROUTING, MULTI_REPO_AGENTS, and the five
agent-integration guides). The two divergent FAQs are now one canonical
FAQ with the comparison-first framing leading and pre-1.0 version gating
removed.

The routing pair inverted: the ported page described a routing system that
does not exist (bd routes, bd hydrate, .beads/routes.jsonl); the page was
rebuilt from the accurate sources (ROUTING.md + MULTI_REPO_AGENTS.md)
against the real surface (routing.mode config, role detection,
repos.primary/additional hydration, --repo override).

Every claim was verified against the Go source or the generated CLI
reference. Phantom surfaces removed across the corpus: bd pin/hook/pour/
wisp/routes/hydrate/reserve/lock/merge/stats, bd hooks status, bd vc
conflicts/log, bd dolt set shared-server, fictional beads_* MCP tool names
(real names taken from beads-mcp server.py), import.orphan_handling and
export.error_policy config keys, database.wal_mode/cache_size, stale
.beads/dolt/sql-server.log paths, and SQLite-era file paths. Notable
corrections: min_hash_length default is 3, .beads/metadata.json is
git-tracked, tombstone status is removed, wisps live in the main database
under an ephemeral flag.

Freshness markers moved with their content (configuration, ide-setup) and
the freshness gate + DOC_INVENTORY ledger now point at the new locations.
Load-bearing anchors preserved: #branchless-workflows-jujutsu--jj,
#circuit-breaker-server-appears-down-failing-fast, #extensible-database,
#multi-repo-hydration. Pointer stubs remain at docs/{SETUP,INSTALLING,
GIT_INTEGRATION}.md because released binaries print those paths
(allowlisted in the docsync guard).

Gates: go test ./test/docsync PASS; generate-cli-docs.sh --check PASS;
check-doc-freshness.sh PASS; mint broken-links: no broken links; mint dev
serves all sections (11 routes spot-checked at 200).
2026-07-12 10:37:07 -07:00
..
advanced.md docs: loss-check merge legacy docs/ originals into the site pages 2026-07-12 10:37:07 -07:00
antivirus.md docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00
configuration.md docs: loss-check merge legacy docs/ originals into the site pages 2026-07-12 10:37:07 -07:00
faq.md docs: loss-check merge legacy docs/ originals into the site pages 2026-07-12 10:37:07 -07:00
git-integration.md docs: loss-check merge legacy docs/ originals into the site pages 2026-07-12 10:37:07 -07:00
index.md docs: canonical concept page, section overviews, and concept diagrams 2026-07-12 10:37:07 -07:00
json-schema.md docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00
observability.md docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00
protected-branches.md docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00
troubleshooting.md docs: loss-check merge legacy docs/ originals into the site pages 2026-07-12 10:37:07 -07:00
worktrees.md docs: port user docs into the Mintlify site tree under docs/ 2026-07-12 10:37:07 -07:00