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>
This commit is contained in:
parent
69573b8810
commit
f7061f9782
3 changed files with 19 additions and 9 deletions
|
|
@ -20,6 +20,8 @@ A curated list of articles and tutorials about Beads.
|
|||
|
||||
## Community Articles
|
||||
|
||||
_Note: the development pace of Beads is very fast and it's easy for offsite content to become outdated._
|
||||
|
||||
- [An Introduction to Beads](https://ianbull.com/posts/beads) by Ian Bull - A practical introduction to Beads with setup instructions and workflow tips.
|
||||
|
||||
- [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.
|
||||
|
|
|
|||
|
|
@ -23,9 +23,6 @@ bd init --contributor
|
|||
|
||||
# Team member (branch workflow for collaboration)
|
||||
bd init --team
|
||||
|
||||
# Protected main branch (GitHub/GitLab)
|
||||
bd init --branch beads-sync
|
||||
```
|
||||
|
||||
The wizard will:
|
||||
|
|
@ -181,16 +178,27 @@ Now bd-2 is ready! 🎉
|
|||
./bd stats
|
||||
```
|
||||
|
||||
## Database Location
|
||||
## Team Sync
|
||||
|
||||
By default: `~/.beads/default.db`
|
||||
|
||||
You can use project-specific databases:
|
||||
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.
|
||||
|
||||
```bash
|
||||
./bd --db ./my-project.db create "Task"
|
||||
# Add a remote (GitHub example — also supports DoltHub, S3, GCS, local paths)
|
||||
bd dolt remote add origin git+ssh://git@github.com/org/repo.git
|
||||
|
||||
# Push your issues
|
||||
bd dolt push
|
||||
|
||||
# Pull teammates' changes
|
||||
bd dolt pull
|
||||
```
|
||||
|
||||
See [DOLT-BACKEND.md](DOLT-BACKEND.md#dolt-remotes) for remote configuration details and [FEDERATION-SETUP.md](../FEDERATION-SETUP.md) for multi-team sync.
|
||||
|
||||
## Database Location
|
||||
|
||||
By default, data is stored in `.beads/dolt/` within your repository.
|
||||
|
||||
## Migrating Databases
|
||||
|
||||
After upgrading bd, use `bd migrate` to check for and migrate old database files:
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ func isDetachedCommitWorktreePath(path string) bool {
|
|||
func gitOutput(dir string, args ...string) (string, error) {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
cmd := exec.CommandContext(ctx, "git", append([]string{"-C", dir}, args...)...)
|
||||
cmd := exec.CommandContext(ctx, "git", append([]string{"-C", dir}, args...)...) //nolint:gosec // args are internal, not user-supplied
|
||||
output, err := cmd.Output()
|
||||
if err != nil {
|
||||
return "", err
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue