beads/docs
matt wilkie 4fe05a3bec
Use getting started docs as bugs to fix (#3034)
* fix: narrow cross-version smoke CI triggers and warn on high skip rate

Remove push-to-main and PR triggers from cross-version smoke test
workflow — 30-45 min runtime is too costly for every push. Keep tag
pushes (releases/RCs) and manual dispatch.

Add a visible warning when >80% of tested versions are skipped, printed
to stderr and GitHub step summary. Prevents silent "all passed" when
nearly nothing actually ran.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: add .buildflags for consistent ICU build configuration

Amp-Thread-ID: https://ampcode.com/threads/T-019d5c3f-42eb-7794-8d59-524bbf77bdf8
Co-authored-by: Amp <amp@ampcode.com>

* Add analysis of getting-started docs: necessity vs. fixable errors

Analyzes ~3,200 lines of getting-started documentation across 9 files.
Finds ~50% of the content compensates for tool-level UX gaps that should
be fixed rather than documented. Categorizes every section as genuinely
necessary, useful reference, workaround for fixable issue, or redundant.
Includes specific recommendations for both tool fixes and doc consolidation.

Requested by @csells.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* Streamline getting-started docs: reduce noise, fix user-facing paths

QUICKSTART.md:
- Change all ./bd to bd (reflects installed binary, not local build)
- Replace go-build install section with brew/npm + link to INSTALLING.md
- Remove Notion sync, database maintenance, and migration sections
  (these are advanced topics, not quickstart material)
- Add "Database maintenance" link to Next Steps

README.md:
- Consolidate installation from ~30 lines to ~8 lines
- Remove CGO/build-from-source details (belong in INSTALLING.md)
- Add links to INSTALLING.md sections for all install methods

INSTALLING.md:
- Demote go install/source to "Contributors / Go developers" in matrix
- Move Build Dependencies section after platform installs, retitle to
  "Build Dependencies (Contributors Only)" with skip-if-prebuilt note
- Add cross-reference to TROUBLESHOOTING.md in troubleshooting section

Net effect: -91 lines, clearer separation between user and contributor
paths, less noise in the first-time experience.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: detect permission errors in bd init with platform-specific guidance

On Windows, Controlled Folder Access can block bd init from creating
.beads/ with no useful error. Now detects os.IsPermission and prints
specific guidance for Windows (CFA whitelist instructions) and Unix
(ls -la / chmod suggestions) instead of a generic failure message.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: add circuit breaker cleanup to bd doctor --fix

Stale circuit breaker files in /tmp/beads-circuit/ can block all bd
operations. Previously users had to manually rm these files. Now
bd doctor detects stale breaker files as a fixable check, and
bd doctor --fix clears them automatically via CleanStaleCircuitBreakerFiles.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* feat: warn about multiple bd binaries in PATH

bd version now scans PATH for duplicate bd executables and warns when
more than one is found. This catches the common case where go install
and Homebrew binaries coexist, causing version confusion. Symlinks
are resolved to avoid false positives.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: show holding process PID in database lock errors

When the Dolt database is locked, the error message now tries to
identify the holding process by scanning /proc for bd/dolt processes.
On Linux, users see e.g. "Process 12345 (bd/dolt) may be holding
the lock." Gracefully degrades to the previous message on platforms
without /proc (macOS, Windows, FreeBSD).

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: only flag circuit breaker files as stale after TTL expires

CheckCircuitBreaker() was counting any open/half-open breaker as stale
regardless of age. This could reset a legitimately active breaker
during a real outage. Now uses the same 5-minute staleness threshold
as CleanStaleCircuitBreakerFiles() — only breakers older than 5 minutes
(from TrippedAt or LastFailure) are flagged for cleanup.

https://claude.ai/code/session_01Fak22deVmDX3KRBKVptJBL

* fix: correct broken doc anchors in README installation links

The "go install" and "from source" links pointed to nonexistent anchors
in INSTALLING.md. Found during review checklist testing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: suppress gosec G304 false positive in circuit breaker check

Path comes from filepath.Glob with a controlled pattern, matching
the same nolint pattern used in internal/storage/dolt/circuit.go.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Amp <amp@ampcode.com>
2026-04-05 16:09:58 -07:00
..
design cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
dev-notes docs: remove stale daemon refs and bd sync --status/--merge references 2026-02-28 19:54:49 -07:00
ADAPTIVE_IDS.md feat: support issue_id_mode=counter for sequential IDs (#2013) 2026-02-22 23:49:46 -08:00
ADVANCED.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
AIDER_INTEGRATION.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
ANTIVIRUS.md harden installers and docs for transparent trust model (GH#1857) 2026-03-15 12:02:56 -07:00
ARCHITECTURE.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
ATTRIBUTION.md fix: remove dead 3-way merge config remnants (GH#2353) 2026-03-05 15:57:33 -08:00
audit-sync-mode-complexity.md fix: complete UUID primary keys cleanup across codebase 2026-03-14 10:12:04 -07:00
CLAUDE.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
CLAUDE_INTEGRATION.md docs: document bd setup command 2025-12-16 01:08:42 -08:00
CLI_REFERENCE.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
COLLISION_MATH.md docs: fix broken relative links across documentation 2025-12-16 00:46:08 -08:00
COMMUNITY_TOOLS.md Add claude-workspace-snapshot to Claude Code Orchestration 2026-03-28 21:04:19 -07:00
CONFIG.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
CONTRIBUTOR_NAMESPACE_ISOLATION.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
COPILOT_INTEGRATION.md fix: replace stale 'bd sync' references with bd dolt push/commit (GH#2435) 2026-03-07 17:00:19 +01:00
DEPENDENCIES.md docs(deps): add DEPENDENCIES.md covering dependency system and gates 2026-02-27 10:09:05 -08:00
DOLT-BACKEND.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
DOLT.md Add credentials file support for Dolt server passwords (#2854) 2026-04-02 20:35:56 -07:00
ERROR_HANDLING.md docs: remove stale daemon refs and bd sync --status/--merge references 2026-02-28 19:54:49 -07:00
EXCLUSIVE_LOCK.md docs(claim): standardize start-work semantics to --claim (#2070) 2026-02-24 22:11:39 -08:00
FAQ.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
GETTING_STARTED_ANALYSIS.md Use getting started docs as bugs to fix (#3034) 2026-04-05 16:09:58 -07:00
GIT_INTEGRATION.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
graph-links.md refactor: remove Gas Town references from codebase 2025-12-30 14:13:32 -08:00
INSTALLING.md Use getting started docs as bugs to fix (#3034) 2026-04-05 16:09:58 -07:00
INTEGRATION_CHARTER.md Add Integration Charter: define scope boundary for tracker integrations 2026-03-30 09:12:28 -07:00
INTERNALS.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
LABELS.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
LINTING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
messaging.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
METADATA.md docs: document issue.metadata field and reserved key prefixes 2026-02-06 02:14:10 -05:00
MOLECULES.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
MULTI_REPO_AGENTS.md fix: add shared Dolt server mode for multi-repo/agent setups (GH#2416) 2026-03-10 17:38:00 -07:00
MULTI_REPO_MIGRATION.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
OBSERVABILITY.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
PERFORMANCE_TESTING.md docs: update stale SQLite references to Dolt across 10 documentation files 2026-02-16 01:22:58 -08:00
PLUGIN.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
pr-752-chaos-testing-review.md docs: remove stale daemon references from all documentation (GH#1982) 2026-02-22 17:57:53 -08:00
PROTECTED_BRANCHES.md fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00
QUICKSTART.md Use getting started docs as bugs to fix (#3034) 2026-04-05 16:09:58 -07:00
README_TESTING.md DOCTOR IMPROVEMENTS: visual improvements/grouping + add comprehensive tests + fix gosec warnings (#656) 2025-12-20 03:10:06 -08:00
RELEASE-STABILITY-GATE.md Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
RELEASING.md docs: remove stale daemon references from all documentation (GH#1982) 2026-02-22 17:57:53 -08:00
REPO_CONTEXT.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
ROUTING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
RULES_AUDIT_DESIGN.md Add bd rules audit and bd rules compact commands (#2810) 2026-04-02 20:29:34 -07:00
SETUP.md feat(setup): target CLAUDE.md and GEMINI.md for hooks integrations 2026-03-15 15:02:52 -07:00
SYNC_SETUP.md /{cmd,docs,internal}: remove file removal that can cause data corruption 2026-03-31 12:04:55 -07:00
TESTING.md refactor(testutil): expand Dolt readiness to 5-state enum (#2304) 2026-03-03 03:55:54 -08:00
TESTING_PHILOSOPHY.md fix: remove dead 3-way merge config remnants (GH#2353) 2026-03-05 15:57:33 -08:00
TODO.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
TROUBLESHOOTING.md /{cmd,docs,internal}: remove file removal that can cause data corruption 2026-03-31 12:04:55 -07:00
UI_PHILOSOPHY.md docs: consolidate duplicate UI_PHILOSOPHY files (GH#745) 2025-12-27 18:01:59 -08:00
UNINSTALLING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
WORKTREES.md fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00