johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update beads.jsonl references to issues.jsonl

Browse Source 
Fixes GH#409 - Documentation inconsistently referred to beads.jsonl
as the canonical filename when issues.jsonl has been the default
since v0.25.1 (bd-6xd).

Updated files:
- docs/ARCHITECTURE.md
- docs/CLI_REFERENCE.md
- docs/PROTECTED_BRANCHES.md
- docs/ADVANCED.md
- docs/GIT_INTEGRATION.md
- docs/MULTI_REPO_AGENTS.md
- docs/MULTI_REPO_MIGRATION.md
- docs/TROUBLESHOOTING.md
- examples/*/README.md
- skills/beads/references/CLI_REFERENCE.md

Note: beads.jsonl is still supported for backward compatibility.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
2025-12-16 01:08:46 -08:00
parent 214b5f9d07
commit 166d66205c
15 changed files with 918 additions and 785 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/MULTI_REPO_MIGRATION.md
View File

@@ -14,7 +14,7 @@ This guide helps you adopt beads' multi-repo workflow for OSS contributions, tea
## What is Multi-Repo Mode?
By default, beads stores issues in `.beads/beads.jsonl` in your current repository. Multi-repo mode lets you:
By default, beads stores issues in `.beads/issues.jsonl` in your current repository. Multi-repo mode lets you:
- **Route issues to different repositories** based on your role (maintainer vs. contributor)
- **Aggregate issues from multiple repos** into a unified view
@@ -223,7 +223,7 @@ bd ready
bd list --json
# Complete team work
git add .beads/beads.jsonl
git add .beads/issues.jsonl
git commit -m "Updated issue tracker"
git push origin main
```
@@ -394,7 +394,7 @@ bd sync
bd list --json
```
### Git merge conflicts in .beads/beads.jsonl
### Git merge conflicts in .beads/issues.jsonl
**Problem:** Multiple repos modifying same JSONL file.
@@ -432,12 +432,12 @@ No migration needed! Multi-repo mode is opt-in:
```bash
# Before (single repo)
bd create "Issue" -p 1
# → Creates in .beads/beads.jsonl
# → Creates in .beads/issues.jsonl
# After (multi-repo configured)
bd create "Issue" -p 1
# → Auto-routed based on role
# → Old issues in .beads/beads.jsonl still work
# → Old issues in .beads/issues.jsonl still work
```
### Disabling Multi-Repo
@@ -461,7 +461,7 @@ bd create "Issue" -p 1
- ❌ Don't mix planning and implementation in the same repo
### Teams
- ✅ Commit `.beads/beads.jsonl` to shared repository
- ✅ Commit `.beads/issues.jsonl` to shared repository
- ✅ Use protected branch workflow for main/master
- ✅ Review issue changes in PRs like code changes
- ❌ Don't gitignore `.beads/` - you lose the git ledger
@@ -481,7 +481,7 @@ bd create "Issue" -p 1
## Related Issues
- [bd-8rd](/.beads/beads.jsonl#bd-8rd) - Migration and onboarding epic
- [bd-mlcz](/.beads/beads.jsonl#bd-mlcz) - `bd migrate` command (planned)
- [bd-kla1](/.beads/beads.jsonl#bd-kla1) - `bd init --contributor` wizard ✅ implemented
- [bd-twlr](/.beads/beads.jsonl#bd-twlr) - `bd init --team` wizard ✅ implemented
- [bd-8rd](/.beads/issues.jsonl#bd-8rd) - Migration and onboarding epic
- [bd-mlcz](/.beads/issues.jsonl#bd-mlcz) - `bd migrate` command (planned)
- [bd-kla1](/.beads/issues.jsonl#bd-kla1) - `bd init --contributor` wizard ✅ implemented
- [bd-twlr](/.beads/issues.jsonl#bd-twlr) - `bd init --team` wizard ✅ implemented