Skip to content

Comments

Fix quickstart EXTENDING.md reference to use full URL#12

Merged
steveyegge merged 1 commit intosteveyegge:mainfrom
elimelec:fix/quickstart-extending-docs-link
Oct 14, 2025
Merged

Fix quickstart EXTENDING.md reference to use full URL#12
steveyegge merged 1 commit intosteveyegge:mainfrom
elimelec:fix/quickstart-extending-docs-link

Conversation

@elimelec
Copy link
Contributor

The quickstart command referenced EXTENDING.md as if it were a local file, which was confusing for users running bd in their own projects. Now it clearly points to the upstream documentation with a full GitHub URL.

  • Changed from "See EXTENDING.md" to "See database extension docs"
  • Added full URL to the original repo's EXTENDING.md
  • Preserved the original "integration patterns" context

🤖 Generated with Claude Code

The quickstart command referenced EXTENDING.md as if it were a local file,
which was confusing for users running bd in their own projects. Now it
clearly points to the upstream documentation with a full GitHub URL.

- Changed from "See EXTENDING.md" to "See database extension docs"
- Added full URL to the original repo's EXTENDING.md
- Preserved the original "integration patterns" context

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

Co-Authored-By: Claude <[email protected]>
@elimelec
Copy link
Contributor Author

DATABASE EXTENSION
  Applications can extend bd's SQLite database:
    • Add your own tables (e.g., myapp_executions)
    • Join with issues table for powerful queries
    • See EXTENDING.md for integration patterns

Ready to start!
Run bd create "My first issue" to create your first issue.

->

DATABASE EXTENSION
  Applications can extend bd's SQLite database:
    • Add your own tables (e.g., myapp_executions)
    • Join with issues table for powerful queries
    • See database extension docs for integration patterns:
      https://github.com/steveyegge/beads/blob/main/EXTENDING.md

Ready to start!
Run bd create "My first issue" to create your first issue.

@steveyegge steveyegge merged commit f3a3d31 into steveyegge:main Oct 14, 2025
steveyegge added a commit that referenced this pull request Oct 14, 2025
Release notes:
- --deps flag for one-command issue creation (#18)
- External reference tracking for linking to external trackers
- Critical bug fixes (dep tree, auto-import, parallel creation)
- Windows build support and Go extension examples
- Community PRs merged (#8, #10, #12, #14, #15, #17)

See CHANGELOG.md for full details.
markthebest12 added a commit to markthebest12/beads that referenced this pull request Jan 24, 2026
P2 Issue steveyegge#9: Remove deprecated resolveGitLabConflictsByTimestamp function
- Delete unused function that was superseded by resolveGitLabConflicts
- Remove associated tests that tested the deprecated function

P3 Issue steveyegge#10: Document cross-project link limitation
- Add doc comment to CreateIssueLink clarifying same-project constraint
- Note that cross-project links will error at GitLab API level

P3 Issue steveyegge#11: Fix ID collision on restart
- Add 4 random bytes to generateIssueID to prevent collisions
- Counter resets on process restart, random component ensures uniqueness
- Add test to verify random component is present

P3 Issue steveyegge#12: Document error handling philosophy
- Add Error Handling Contract comment at top of gitlab_sync.go
- Documents fatal vs non-fatal error handling approach
- Clarifies that stats track error counts for reporting

Co-Authored-By: Claude Opus 4.5 <[email protected]>
steveyegge pushed a commit that referenced this pull request Jan 31, 2026
P2 Issue #9: Remove deprecated resolveGitLabConflictsByTimestamp function
- Delete unused function that was superseded by resolveGitLabConflicts
- Remove associated tests that tested the deprecated function

P3 Issue #10: Document cross-project link limitation
- Add doc comment to CreateIssueLink clarifying same-project constraint
- Note that cross-project links will error at GitLab API level

P3 Issue #11: Fix ID collision on restart
- Add 4 random bytes to generateIssueID to prevent collisions
- Counter resets on process restart, random component ensures uniqueness
- Add test to verify random component is present

P3 Issue #12: Document error handling philosophy
- Add Error Handling Contract comment at top of gitlab_sync.go
- Documents fatal vs non-fatal error handling approach
- Clarifies that stats track error counts for reporting

Co-Authored-By: Claude Opus 4.5 <[email protected]>

Executed-By: beads/crew/emma
Rig: beads
Role: crew
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants