docs(cli): update README and specification to link migration guide and reflect V3-only CLI structure #4380

Open
opened 2026-04-08 11:29:13 +00:00 by HAL9000 · 0 comments
Owner

Metadata

  • Commit Message: docs(cli): update README and specification to link migration guide and reflect V3-only CLI structure
  • Branch: docs/cli-v3-documentation-updates
  • Parent Epic: #4182

Background and Context

Epic #4182 identifies that documentation (README, specification) does not reflect the V3-only CLI structure after legacy command removal. Once the migration guide (#4376) and CLI changes (#4181) are complete, the main documentation needs to be updated to reflect the new state.

Expected Behavior

  • README.md prominently links to the migration guide for users coming from legacy workflow
  • docs/specification.md CLI Commands section accurately reflects V3-only commands
  • Any references to legacy commands in documentation are removed or updated
  • Documentation is internally consistent (no contradictions between files)

Acceptance Criteria

  • README.md links to docs/Legacy_to_V3_Guide.md
  • docs/specification.md CLI Commands section reflects V3-only command structure
  • No references to deprecated legacy commands in main documentation
  • Documentation is internally consistent
  • All links in documentation are valid

Supporting Information

  • Key files: README.md, docs/specification.md (CLI Commands section: lines 199–368)
  • Related: #4376 (migration guide), #4181 (CLI help output), #4182 (parent epic)
  • Depends on: #4376 (migration guide must exist first), #4181 (CLI changes must be complete)

Subtasks

  • Update README.md to add link to migration guide in Getting Started section
  • Update docs/specification.md CLI Commands section to remove legacy command references
  • Verify all internal documentation links are valid
  • Check for any other documentation files referencing legacy commands
  • Tests (Behave): Add scenario verifying README contains link to migration guide
  • Run nox (all default sessions), fix any errors
  • Verify coverage >= 97% via nox -s coverage_report

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • All documentation reflects the V3-only CLI structure.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional details.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
  • All nox stages pass.
  • Coverage >= 97%.

Automated by CleverAgents Bot
Supervisor: Product Builder | Agent: epic-planner

## Metadata - **Commit Message**: `docs(cli): update README and specification to link migration guide and reflect V3-only CLI structure` - **Branch**: `docs/cli-v3-documentation-updates` - **Parent Epic**: #4182 ## Background and Context Epic #4182 identifies that documentation (README, specification) does not reflect the V3-only CLI structure after legacy command removal. Once the migration guide (#4376) and CLI changes (#4181) are complete, the main documentation needs to be updated to reflect the new state. ## Expected Behavior - `README.md` prominently links to the migration guide for users coming from legacy workflow - `docs/specification.md` CLI Commands section accurately reflects V3-only commands - Any references to legacy commands in documentation are removed or updated - Documentation is internally consistent (no contradictions between files) ## Acceptance Criteria - [ ] `README.md` links to `docs/Legacy_to_V3_Guide.md` - [ ] `docs/specification.md` CLI Commands section reflects V3-only command structure - [ ] No references to deprecated legacy commands in main documentation - [ ] Documentation is internally consistent - [ ] All links in documentation are valid ## Supporting Information - **Key files**: `README.md`, `docs/specification.md` (CLI Commands section: lines 199–368) - **Related**: #4376 (migration guide), #4181 (CLI help output), #4182 (parent epic) - **Depends on**: #4376 (migration guide must exist first), #4181 (CLI changes must be complete) ## Subtasks - [ ] Update `README.md` to add link to migration guide in Getting Started section - [ ] Update `docs/specification.md` CLI Commands section to remove legacy command references - [ ] Verify all internal documentation links are valid - [ ] Check for any other documentation files referencing legacy commands - [ ] Tests (Behave): Add scenario verifying README contains link to migration guide - [ ] Run `nox` (all default sessions), fix any errors - [ ] Verify coverage >= 97% via `nox -s coverage_report` ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - All documentation reflects the V3-only CLI structure. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional details. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done. - All nox stages pass. - Coverage >= 97%. --- **Automated by CleverAgents Bot** Supervisor: Product Builder | Agent: epic-planner
HAL9000 added this to the v3.5.0 milestone 2026-04-08 17:42:55 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
cleveragents/cleveragents-core#4380
No description provided.