fix(docs): correct misleading examples in QUICKSTART.md#2322
Merged
steveyegge merged 1 commit intosteveyegge:mainfrom Mar 4, 2026
Merged
fix(docs): correct misleading examples in QUICKSTART.md#2322steveyegge merged 1 commit intosteveyegge:mainfrom
steveyegge merged 1 commit intosteveyegge:mainfrom
Conversation
Two issues: 1. Epic child creation commands were missing the --parent flag, making it appear that child tasks are automatically associated with the most recently created epic. The --parent flag is required. 2. The dependency visibility example (bd list showing "blocked by" annotations) was placed immediately after issue creation, before any dependencies were added. Moved it after the "Add Dependencies" section where it makes sense. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two inaccuracies in
docs/QUICKSTART.md:Missing
--parentflag in epic child creation — The "Hierarchical Issues" section shows child tasks being created without specifying which epic they belong to. Without the--parentflag, these are created as standalone issues with random IDs, not as children with.1,.2,.3suffixes. Added--parent bd-a3f8e9to each child creation command.Dependency visibility example shown before dependencies exist — The
bd listoutput showing(blocked by: ...)annotations was placed in the "Your First Issues" section, immediately after creating issues with no dependencies. Moved it after the "Add Dependencies" section where the dependencies are actually established.Both issues were verified by building
bdfrom source and testing the commands.Test plan
bdand created an epicbd create "child" -p 1(without--parent) creates a standalone issuebd create "child" -p 1 --parent <epic-id>creates a hierarchical child with.Nsuffixbd children <epic-id>lists the children correctly🤖 Generated with Claude Code