Observed Behavior
README.md contains outdated and missing documentation for features released in v0.5.0:
- The new
prune command is completely omitted from both the Table of Contents and the Commands section.
- The
remove command documentation lacks mention of the new --delete-branch option.
- The Directory Structure and Templates sections still reference
config.json instead of config.toml and allowed_hooks.json.
Expected Behavior
README.md should accurately document all available CLI subcommands, flags, and configuration file formats.
Steps to Reproduce
- Open
README.md.
- Check Table of Contents (
#table-of-contents) and Commands (#commands): notice prune is absent.
- Check
remove command details: --delete-branch is missing.
- Check lines 80 and 136:
config.json is referenced instead of config.toml.
Minimal Reproduction Environment / Conditions
- Version / Branch / Commit:
release-v0.5.x@6d07c0c
- File:
README.md
Deliverables & Testing Requirements
- Add
prune command documentation to Table of Contents and Commands collapsible sections.
- Document
--delete-branch parameter under remove command.
- Update directory structure diagram and variable description to reference
config.toml.
- Verify markdown rendering and anchor link integrity.
Technical Pointers & Root Cause Clues
- Suspected Components:
README.md:15-32, 70-84, 136, 203-213
- Related Commits:
bd7ed4c, c953c29, f96f3fb
Notes & Edge Cases
- Keeps documentation synchronized with the CLI before final tag release.
Metadata
Severity / Priority: P2 (Medium)
Area: documentation
AI Usage
Drafted with Gemini following the DEEP framework based on code review findings against release-v0.5.x. Reproduction conditions and code references were verified in the codebase.
Observed Behavior
README.mdcontains outdated and missing documentation for features released in v0.5.0:prunecommand is completely omitted from both the Table of Contents and the Commands section.removecommand documentation lacks mention of the new--delete-branchoption.config.jsoninstead ofconfig.tomlandallowed_hooks.json.Expected Behavior
README.mdshould accurately document all available CLI subcommands, flags, and configuration file formats.Steps to Reproduce
README.md.#table-of-contents) and Commands (#commands): noticepruneis absent.removecommand details:--delete-branchis missing.config.jsonis referenced instead ofconfig.toml.Minimal Reproduction Environment / Conditions
release-v0.5.x@6d07c0cREADME.mdDeliverables & Testing Requirements
prunecommand documentation to Table of Contents and Commands collapsible sections.--delete-branchparameter underremovecommand.config.toml.Technical Pointers & Root Cause Clues
README.md:15-32, 70-84, 136, 203-213bd7ed4c,c953c29,f96f3fbNotes & Edge Cases
Metadata
Severity / Priority: P2 (Medium)
Area:
documentationAI Usage
Drafted with Gemini following the DEEP framework based on code review findings against
release-v0.5.x. Reproduction conditions and code references were verified in the codebase.