docs: unify cli command references
Metadata
Current evaluation
Closed unmerged: review requested redirects and Sphinx duplicate-label fixes for the generated per-command pages. The same grouped commands.rst reference was later landed via merged PR canonical/rockcraft#1379.
Resolution: closed superseded
Reason: The PR sat in changes_requested with maintainer asanvaq asking for redirects in redirects.txt and an exclude_patterns entry in docs/conf.py for the generated docs/reference/commands/*.rst files (duplicate label/Sphinx indentation errors). It was closed without merging and replaced by PR canonical/rockcraft#1379, which merged the same grouped CLI command reference (lifecycle/extension/other) plus the missing redirects.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This updates the CLI command reference documentation so that all commands are rendered from a single commands.rst page, grouped into:
Lifecycle commands
Extension commands
Other commands
The CLI documentation generator was updated to generate the grouped command reference content instead of separate user-facing pages for each command.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed superseded | Closed unmerged: review requested redirects and Sphinx duplicate-label fixes for the generated per-command pages. The same grouped commands.rst reference was later landed via merged PR canonical/rockcraft#1379. | |
| stealth/space-bunny-alpha | — | closed stale | PR #1365 was closed unmerged after requested redirects and Sphinx fixes for generated CLI documentation remained unresolved. | |
| stealth/space-bunny-alpha | — | closed stale | PR #1365 was closed unmerged after review requested redirects and fixes for Sphinx indentation and duplicate-label errors. | |
| stealth/space-bunny-alpha |
Impact:
35
Quick Win:
6
Complexity:
40
Confidence:
88
Actionability:
30
|
needs review | Consolidates generated CLI references into one grouped commands page. Changes are requested pending redirects and fixes for reported Sphinx indentation and duplicate-label errors. | |
| stealth/space-bunny-alpha |
Impact:
33
Quick Win:
11
Complexity:
28
Confidence:
93
Actionability:
46
|
keep open | Consolidates CLI references into one grouped commands page and updates its generator; changes requested because required redirects are not yet implemented. | |
| stealth/space-bunny-alpha |
Impact:
36
Quick Win:
9
Complexity:
38
Confidence:
87
Actionability:
42
|
keep open | Generates one grouped CLI command reference page and removes separate command pages; green reported CI, but requested redirects remain unresolved and source-spread-tests is pending. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
26
Staleness:
0
Complexity:
15
Confidence:
75
|
needs review | Refactors CLI command documentation into a single grouped page. Under review with changes requested; author awaiting team feedback on TOC simplification and redirect strategy. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
18
Staleness:
0
Complexity:
10
Confidence:
70
|
keep open | Documentation PR unifying CLI command references into a single grouped commands.rst page. Reviewer has requested changes; awaiting author updates. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
18
Staleness:
0
Complexity:
10
Confidence:
80
|
needs review | Renames CLI command reference pages to be grouped into Lifecycle, Extension, and Other commands sections instead of separate per-command pages. |
Update history
| Date | Change |
|---|---|
| closed | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Superseded By:
canonical/rockcraft#1379
(confidence 92%)
Merged PR with the same title that consolidates CLI commands into one commands.rst page, updates the doc generator TOC, and adds redirects for the old per-command pages.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1378 docs: unify all CLI command references in one page | rockcraft | closed | Closed unmerged and superseded by canonical/rockcraft#1379, which consolidated CLI references into one grouped commands.rst page and added redirects. | |
| #1379 docs: unify cli command references | rockcraft | merged | Merged PR canonical/rockcraft#1379 consolidates the CLI reference into one commands.rst (lifecycle/extension/other), fixes the doc generator TOC, and adds redirects for the old per-command pages. It replaces #1365. | |
| #1354 CODA: unify all CLI command references in one page | rockcraft | closed | Unified Rockcraft CLI command documentation onto one page; the change landed in commit 079ae670 via PR #1379. |