Commit graph

27 commits

Author SHA1 Message Date
matt wilkie
fd3c6094de
docs: fix FAQ "git-based" misframing (Dolt-native, not git-based) (#3712)
The FAQ opened by calling beads a "git-based issue tracker", which
contradicts the Dolt-native architecture documented elsewhere (README
opens with "Distributed graph issue tracker for AI agents, powered by
Dolt"; the FAQ itself later explains `bd dolt push` / `bd dolt pull`
and Dolt branches independent of git branches).

Newcomers reading the FAQ first formed an incorrect mental model:
storage backend = git, sync mechanism = git push/pull. In reality,
issues live in a local Dolt database and sync via Dolt remotes; git
is only involved for project code (and optionally for ferrying the
exported `.beads/issues.jsonl` between machines).

Replaced "git-based issue tracker" with "version-controlled issue
tracker" — accurate without dropping the "Dolt" vendor name in the
opening line (newcomers do not yet recognize Dolt; it is introduced
later in the FAQ where context is built up).

Also fixed downstream misframings in the same file:
  - "Git-First, ..." differentiator header  -> "Offline-First, ..."
  - "git-synchronized task memory"          -> "version-controlled task memory"
  - "Git-native sync"                       -> "Built-in sync" (Taskwarrior comparison)
  - "Sync via git commits"                  -> "Sync via `bd dolt push` / `bd dolt pull`"
  - "bd's git-based sync"                   -> "bd's version-controlled storage" + cell-level merge
  - "Sync happens via git push/pull"        -> "Sync happens via `bd dolt push` / `bd dolt pull`"

Left genuine git references untouched: the merge-conflict section
showing JSONL diffs (issues.jsonl is a real git-tracked artifact for
portability), git hooks, `bd init`'s git interaction, the "walks up
like git" auto-discovery analogy, and the worktree FAQs.

Tracking: mybd-ujr
GH: #3683
PR: #3706 (precursor)

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 14:35:18 -07:00
matt wilkie
112be87f80
Add bd init --remote bootstrap path (#3527)
* Add init remote bootstrap path (bd-cil)

* fix(init): adopt source _project_id when bootstrapping from remote

When `bd init --remote=<url>` cloned an existing Dolt remote, the
ProjectID adoption gate at init.go:867 only fired for `--database`
(GH#2922), so a fresh ProjectID was minted and then written back to
the cloned database, overwriting the source rig's identity and
breaking cross-project verification on subsequent pulls.

Extend the gate to also adopt when `bootstrappedFromRemote` is true,
matching the GH#2922 intent: if another rig already chose an
identity, inherit it rather than overwrite.

Fixes the failing TestEmbeddedInit/remote_bootstraps_existing_dolt_data
subtest added in this PR. The other --remote subtests (empty source,
plain git origin) and the GH#2922 --database path are unaffected.

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

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-27 13:45:26 -07:00
Ben Madore
3b39ce577a
docs: update user-facing URLs from steveyegge/beads to gastownhall/beads
Co-authored-by: Ben Madore <823868+madorb@users.noreply.github.com>
2026-04-24 08:17:42 -07:00
coffeegoddd☕️✨
fb8ff3b46d /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
coffeegoddd☕️✨
9134355618 /{README.md,cmd,docs,internal,website}: doc updates 2026-03-28 13:47:20 -07:00
Joseph Turian
6f0e2208ec Add backup fetch-git and git snapshot follow-ups (bd-mtqql) 2026-03-14 23:12:47 -04:00
Amp
a333dcaa75 fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522)
Systematic cleanup of stale documentation references left over from the
Dolt migration:

- Replace all 'bd sync' → 'bd dolt push' / 'bd dolt pull' across 40+ files
- Replace all 'bd import' → 'bd init --from-jsonl' or remove
- Replace 'bd init --branch' → note about refs/dolt/data separation
- Fix AGENT_INSTRUCTIONS.md (highest impact: agents read this directly)
- Fix npm-package, claude-plugin, integrations, examples, website docs

Add scripts/check-doc-flags.sh to catch stale doc references:
- Checks for removed commands (bd sync, bd import)
- Checks for removed flags (bd init --branch)
- Warns on legacy SQLite/beads.db references
- Compares CLI_REFERENCE.md against bd help --all

Add CI job (check-doc-flags) and Makefile target (check-docs) to gate
PRs against doc freshness.

Prior art: feat/help-doc-generator branch has bd help --doc/--list for
generating docs FROM CLI output. This script validates docs AGAINST CLI
output — complementary approaches.

Amp-Thread-ID: https://ampcode.com/threads/T-019cde77-0722-7353-b63a-1779a5773ca6
Co-authored-by: Amp <amp@ampcode.com>
2026-03-11 13:25:40 -07:00
beads/crew/emma
396c944a5e fix: add shared Dolt server mode for multi-repo/agent setups (GH#2416)
Introduces BEADS_DOLT_SHARED_SERVER mode where multiple beads projects
share a single Dolt server on a fixed port (3308), avoiding per-project
server sprawl. Includes `bd init --shared-server`, `bd dolt shared-*`
commands, doctor checks, and comprehensive tests.

Co-Authored-By: Shybko <shybko@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-10 17:38:00 -07:00
vp
4f4cc4118e docs(faq): clarify atomic self-pick claim wording 2026-02-25 10:44:22 +03:00
vp
999d158cc3 docs(faq): reorder assigned-vs-claim note 2026-02-25 10:43:24 +03:00
vp
05727efe2d docs(faq): restore assigned-work flow and clarify claim semantics 2026-02-25 10:40:40 +03:00
vp
95c86e1160 docs(faq): require assignee in claim example 2026-02-25 10:25:26 +03:00
vp
06cc556a33 docs(faq): note optional assignee with claim 2026-02-25 10:19:34 +03:00
vp
f5c2da1d2f docs(claim): address review nits and unblock resume semantics
- use --status in_progress for unblock/resume example\n- fix llms short reference comment to 'Start work'\n- simplify FAQ multi-agent claim flow
2026-02-25 10:01:52 +03:00
vp
fbc90a3e75 docs(claim): use --claim for start-work flows across docs, examples, and templates 2026-02-24 04:17:48 +03:00
beads/crew/elinor
90da8f6028 docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4)
Replace JSONL storage/sync references with Dolt-native equivalents across
documentation, plugin resources, website docs, agent instructions, and
example READMEs. Preserves legitimate JSONL references (bd import/export
commands, CHANGELOG history, routes.jsonl/interactions.jsonl concepts).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-22 22:18:02 -08:00
topaz
062aedbed7 docs: remove stale daemon references from all documentation (GH#1982)
Sweep 65 markdown files across docs/, website/, claude-plugin/, examples/,
integrations/, and root to replace removed `bd daemon` references with
current Dolt server mode equivalents. CHANGELOG.md preserved per policy.

Key replacements:
- `bd daemon start/stop/status` → `bd dolt start/stop` / `bd doctor`
- `bd daemons killall/health/logs` → `bd dolt stop` / `bd doctor`
- `--no-daemon` flag → removed (embedded mode is default)
- `BEADS_NO_DAEMON` / `BEADS_DAEMON_MODE` env vars → removed
- `.beads/bd.sock` → removed
- "daemon mode" / "direct mode" → "server mode" / "embedded mode"
- daemon.pid/daemon.log → .beads/dolt/sql-server.pid/.log

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

Executed-By: beads/polecats/topaz
Rig: beads
Role: polecats
2026-02-22 17:57:53 -08:00
beads/crew/emma
bd68c87b00 fix: remove stale embedded Dolt references after server-only migration
Delete broken store_nocgo_test.go (references undefined errNoCGO),
remove dead bootstrapEmbeddedDolt/hasDoltSubdir functions, and clean up
stale comments and docs that still referenced embedded mode, CGO
requirements, or in-process Dolt across 20 files.

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

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-21 16:59:44 -08:00
emma
5083873779 cleanup: delete deprecated SQLite-era docs (EXTENDING.md, MULTI_REPO_HYDRATION.md)
These documents described SQLite-specific features that no longer exist
after the Dolt migration. Preserved in git history. Updated references
in ARCHITECTURE.md and FAQ.md.

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

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-16 01:22:58 -08:00
emma
4103785ef3 docs: update stale SQLite references to Dolt across 10 documentation files
Major updates:
- ARCHITECTURE.md: Rewrote three-layer model to two-layer (Dolt + JSONL),
  updated all diagrams, directory structure, and code paths
- FAQ.md: Updated database references, dependencies, corruption FAQ
- TROUBLESHOOTING.md: Updated database corruption recovery, locking advice
- WORKTREES.md: Updated directory structure and concurrency references
- MULTI_REPO_HYDRATION.md: Added deprecation notice (SQLite-era feature)
- daemon-summary.md: Added migration note

Path updates:
- PERFORMANCE_TESTING.md: sqlite → dolt benchmark paths
- ADAPTIVE_IDS.md: sqlite → dolt implementation paths
- INTERNALS.md: sqlite → dolt implementation paths
- SECURITY.md: SQLite → Dolt in dependency and storage references

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

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-16 01:22:58 -08:00
Adam Spiers
d71601d98e
docs: fix README and PLUGIN.md documentation issues (#763)
docs: fix README and PLUGIN.md documentation issues

- Clarify that bd ready shows issues ready to work on (#512)
- Update git hooks install command from deprecated script to bd hooks install (#513)
- Fix Claude Code plugin local install: use ./beads not ., clarify shell vs CC commands (#514)

Fixes #512, #513, #514
2025-12-27 17:20:00 -08:00
Steve Yegge
d77a697cee feat: add bd admin parent command for cleanup/compact/reset (bd-3u8m)
Move cleanup, compact, and reset commands under `bd admin` namespace.
Creates hidden aliases for backwards compatibility that show deprecation
notice when used.

- Create cmd/bd/admin.go with parent command
- Create cmd/bd/admin_aliases.go for hidden backwards-compat aliases
- Update cleanup.go, compact.go, reset.go to remove rootCmd.AddCommand
- Update all documentation to use `bd admin <cmd>` syntax

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-27 16:21:08 -08:00
Steve Yegge
8306b2b8f3 Merge bd-2k5f-pumpjack: GH#483 2025-12-16 01:18:02 -08:00
Steve Yegge
25ea1e7de3 docs: fix broken relative links across documentation
Fixes 46 broken relative links across 20 documentation files in docs/.

Changes:
- Added ../ prefix for root files (README.md, AGENTS.md)
- Removed ../ prefix for sibling docs files
- Removed dead links to non-existent files
- Fixed subdirectory paths

Based on PR #574 by chrisvaillancourt.

Co-Authored-By: Chris Vaillancourt <chrisvaillancourt@users.noreply.github.com>
2025-12-16 00:46:08 -08:00
Steve Yegge
344fc1b95d docs: explain sync-branch worktree behavior (GH#510)
Add comprehensive documentation about beads-created worktrees:
- New section in WORKTREES.md explaining why and where beads creates worktrees
- Common confusion: 'beads took over main!' with solution
- Troubleshooting entries for 'branch already checked out' errors
- FAQ entry: 'Why did beads create worktrees in my .git directory?'

This addresses user confusion when beads' sync-branch feature creates
internal worktrees that can lock branches users want to checkout.

Closes #510

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-14 17:20:12 -08:00
Steve Yegge
54702b59a2 Fix #264 and #262: Remove stale --resolve-collisions references
- Update examples/git-hooks README to use 'bd hooks install' instead of non-existent install.sh
- Fix post-merge hook error message to not suggest --resolve-collisions flag (removed in v0.20)
- Clean up all doc references to --resolve-collisions (flag removed, hash IDs prevent collisions)

Fixes #264 (git hooks installer missing)
Fixes #262 (misleading error message)

Amp-Thread-ID: https://ampcode.com/threads/T-c9f0e4cb-fba2-4db2-a3d5-36dc1892be9d
Co-authored-by: Amp <amp@ampcode.com>
2025-11-08 13:18:50 -08:00
Steve Yegge
584c266684 Reorganize project structure: move Go files to internal/beads, docs to docs/
Amp-Thread-ID: https://ampcode.com/threads/T-7a71671d-dd5c-4c7c-b557-fa427fceb04f
Co-authored-by: Amp <amp@ampcode.com>
2025-11-05 21:04:00 -08:00
Renamed from FAQ.md (Browse further)