Skip to content

docs(agents): mark beads/bd tracking as a historical artifact - #237

Merged
aspiers merged 2 commits into
mainfrom
fix/agents-beads-historical
Aug 4, 2026
Merged

docs(agents): mark beads/bd tracking as a historical artifact#237
aspiers merged 2 commits into
mainfrom
fix/agents-beads-historical

Conversation

@aspiers

@aspiers aspiers commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

AGENTS.md still carried a full BEADS INTEGRATION how-to block presenting bd (beads) as the live task-tracking system for this repo — "Use bd for ALL task tracking", "Do NOT use external issue trackers", command recipes, an auto-sync section, etc.

That is no longer true. beads was only used during the repository's initial buildout; the .beads/ directory and its bd database are now a historical artifact. The database is stale and may not even open (it currently errors on failed to initialize schema: pending schema migrations). The old guidance therefore actively misleads AI agents into resurrecting a dead workflow.

Changes

Before After
Beads section (~90 lines) "Issue Tracking with bd (beads)" how-to: why bd, quick start, issue types, priorities, agent workflow, auto-sync, rules Short "Issue Tracking (historical: bd / beads)" note: .beads/ is retained-for-history-only; do not use bd; use the GitHub issue tracker
"Landing the Plane" step 3 "Update issue status" (bd-flavoured) removed
"Landing the Plane" push block included bd dolt push removed; git pull/push/verify flow kept
docs/QUICKSTART.md reference linked (file does not exist) dropped with the block

The <!-- BEGIN/END BEADS INTEGRATION --> markers are kept as anchors. They are unrelated to bd's git-hook markers under .beads/hooks/, so this is a plain manual edit — bd tooling does not regenerate this block.

Scope / non-changes

  • Docs-only, AGENTS.md only. Not in the npm package files, not the downstream SKILL.md, so no changeset per the writing-changesets skill.
  • .beads/ files themselves are left in place (still git-tracked) — this PR only stops the docs from telling agents to use them.
  • Prettier clean.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated repository task-tracking guidance to use GitHub issues instead of the legacy beads workflow.
    • Revised session-completion instructions for creating follow-up issues, syncing changes, pushing updates, and verifying repository status.
    • Clarified that historical task-tracking artifacts are inactive and should no longer be used for managing work.

The BEADS INTEGRATION block still presented bd as a live task-tracking
system ("Use bd for ALL task tracking", "Do NOT use external issue
trackers"), but beads was only used during the repository's initial
buildout. The bd database is now stale and may not even open, so this
guidance actively misleads agents into resurrecting a dead workflow.

Replace the ~90-line how-to block with a short note framing `.beads/`
and its database as retained-for-history-only, directing task tracking
to the GitHub issue tracker. Also drop the `bd dolt push` step and the
bd-specific issue-status step from "Landing the Plane", keeping the
still-valid git pull/push/verify flow.

The stale reference to the non-existent docs/QUICKSTART.md is dropped
as part of removing the block.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 24, 2026 16:19
@changeset-bot

changeset-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 5e5196d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d690a163-1923-43cd-956c-4d673d64a9e0

📥 Commits

Reviewing files that changed from the base of the PR and between 06664a1 and 5e5196d.

📒 Files selected for processing (1)
  • AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

AGENTS.md replaces bd-based task tracking guidance with GitHub issue instructions and updates session completion steps to use a git-only synchronization and push workflow.

Changes

Task tracking and completion workflow

Layer / File(s) Summary
Tracking and session completion workflow
AGENTS.md
Marks .beads/ and bd as historical artifacts, directs agents to GitHub issues, and updates completion steps to use git pull --rebase, git push origin HEAD, and a status check.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 7
✅ Passed checks (7 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change that marks Beads and bd tracking as historical artifacts.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Lexicon Documentation Sync ✅ Passed The PR changes only AGENTS.md, which the check explicitly excludes; no lexicon, README.md, ERD.puml, or SCHEMAS.md synchronization review is required.
Lexicons Styleguide Compliance ✅ Passed No lexicon style violation was introduced: the relevant JSON is valid, uses lowerCamelCase and descriptions, and removes the obsolete schema and its references.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/agents-beads-historical

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 399-412: Reconcile the bd retirement guidance in AGENTS.md: update
the historical .beads section at AGENTS.md lines 399-412 to acknowledge that
.beads/hooks/pre-push may still invoke bd, or remove/disable that hook. Also
update the completion workflow at AGENTS.md lines 422-429 to state that git push
origin HEAD can trigger the pre-push hook and account for its behavior.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1ce54a4f-b642-443d-8339-ed75faabd390

📥 Commits

Reviewing files that changed from the base of the PR and between 456c55c and 06664a1.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
CodeRabbit flagged that retaining .beads/hooks/pre-push contradicts the
new "do not use bd" guidance, since that script invokes bd when it is
on PATH. The script's contents do call bd, but git never runs it: the
repo's prepare script installs husky, which sets core.hooksPath to
.husky/, so nothing under .beads/hooks/ is ever consulted.

Say so explicitly rather than leaving the reader to infer it from the
word "retained".

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings August 3, 2026 11:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@aspiers
aspiers requested a review from Kzoeps August 3, 2026 15:15
@aspiers
aspiers merged commit f77ca95 into main Aug 4, 2026
10 checks passed
@aspiers
aspiers deleted the fix/agents-beads-historical branch August 4, 2026 16:01
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.

3 participants