Skip to content

Commit f7061f9

Browse files
maphewAmpampcode-com
authored
fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525)
- Remove bd init --branch beads-sync (flag no longer exists) - Replace stale ~/.beads/default.db with correct .beads/dolt/ location - Add outdated-content disclaimer to Community Articles in ARTICLES.md Amp-Thread-ID: https://ampcode.com/threads/T-019cde55-544a-701a-a0e2-c06dee329d6a Co-authored-by: Amp <amp@example.com> Co-authored-by: Amp <amp@ampcode.com>
1 parent 69573b8 commit f7061f9

3 files changed

Lines changed: 19 additions & 9 deletions

File tree

ARTICLES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ A curated list of articles and tutorials about Beads.
2020

2121
## Community Articles
2222

23+
_Note: the development pace of Beads is very fast and it's easy for offsite content to become outdated._
24+
2325
- [An Introduction to Beads](https://ianbull.com/posts/beads) by Ian Bull - A practical introduction to Beads with setup instructions and workflow tips.
2426

2527
- [Beads: Memory for Your Coding Agents](https://paddo.dev/blog/beads-memory-for-coding-agents/) by Paddo - Deep dive into how Beads stores everything in Git and what it's really for.

docs/QUICKSTART.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ bd init --contributor
2323

2424
# Team member (branch workflow for collaboration)
2525
bd init --team
26-
27-
# Protected main branch (GitHub/GitLab)
28-
bd init --branch beads-sync
2926
```
3027

3128
The wizard will:
@@ -181,16 +178,27 @@ Now bd-2 is ready! 🎉
181178
./bd stats
182179
```
183180

184-
## Database Location
185-
186-
By default: `~/.beads/default.db`
181+
## Team Sync
187182

188-
You can use project-specific databases:
183+
Share issues with your team using Dolt remotes. You can even use the same Git repo as your source code — Dolt stores data under `refs/dolt/data`, separate from standard Git refs.
189184

190185
```bash
191-
./bd --db ./my-project.db create "Task"
186+
# Add a remote (GitHub example — also supports DoltHub, S3, GCS, local paths)
187+
bd dolt remote add origin git+ssh://git@github.com/org/repo.git
188+
189+
# Push your issues
190+
bd dolt push
191+
192+
# Pull teammates' changes
193+
bd dolt pull
192194
```
193195

196+
See [DOLT-BACKEND.md](DOLT-BACKEND.md#dolt-remotes) for remote configuration details and [FEDERATION-SETUP.md](../FEDERATION-SETUP.md) for multi-team sync.
197+
198+
## Database Location
199+
200+
By default, data is stored in `.beads/dolt/` within your repository.
201+
194202
## Migrating Databases
195203

196204
After upgrading bd, use `bd migrate` to check for and migrate old database files:

internal/beads/beads.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ func isDetachedCommitWorktreePath(path string) bool {
178178
func gitOutput(dir string, args ...string) (string, error) {
179179
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
180180
defer cancel()
181-
cmd := exec.CommandContext(ctx, "git", append([]string{"-C", dir}, args...)...)
181+
cmd := exec.CommandContext(ctx, "git", append([]string{"-C", dir}, args...)...) //nolint:gosec // args are internal, not user-supplied
182182
output, err := cmd.Output()
183183
if err != nil {
184184
return "", err

0 commit comments

Comments
 (0)