docs: unify cli command references
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR itself was merged (approved by 2 reviewers, e.g. asanvaq) with CI checks passing. It supersedes canonical/rockcraft#1365, which was closed unmerged after reviewers asked for the redirects and Sphinx duplicate-label fixes that #1379 then added.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This implements the fixes suggested by @asanvaq for the CLI command reference documentation.
The original change consolidated the CLI command reference into a single `commands.rst` page, with commands grouped into:
* Lifecycle commands
* Extension commands
* Other commands
This PR addresses the follow-up issues from that change:
* Updates the generated documentation structure so the right-hand TOC contains only the command groups and individual commands, rather than additional entries such as Usage and Options.
* Adds redirects for the old individual command pages so existing links continue to work and point to the corresponding command sections in `commands.rst`.
The CLI documentation generator was updated accordingly to support the new structure and redirects.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| qwen/qwen3.8-27b | — | closed resolved | Merged. Consolidates the CLI command reference into a single commands.rst page grouped by lifecycle, extension, and other commands, updates the doc generator's TOC, and adds redirects for old per-command pages. Replaces PR #1365. | |
| qwen/qwen3.8-27b | — | closed resolved | Merged. Consolidates the CLI command reference into a single commands.rst page grouped by lifecycle/extension/other, updates the doc generator's TOC, and adds redirects for old per-command pages. Replaces PR #1365. | |
| qwen/qwen3.8-27b | — | closed resolved | Merged into main. Consolidates the CLI command reference into a single commands.rst page grouped by lifecycle/extension/other commands, updates the docs generator for the new TOC structure, and adds redirects for old per-command pages. Supersedes #1365. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
25
Complexity:
20
Confidence:
85
Actionability:
88
|
needs review | Consolidates CLI command reference docs into a single commands.rst page with a grouped TOC, adds redirects for old per-command pages, and updates the docs generator. Approved by 2 reviewers, 0 unresolved comments, CI green. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
17
Complexity:
20
Confidence:
75
Actionability:
62
|
needs review | Consolidates CLI command reference into one commands.rst page with grouped TOC, updates the docs generator, and adds redirects for old per-command pages. Replaces closed #1365. Approved, 0 unresolved comments; 3 CI checks failing (spread, slow tests). | |
| stealth/space-bunny-alpha |
Impact:
28
Quick Win:
11
Complexity:
30
Confidence:
74
Actionability:
58
|
needs review | Follow-up docs PR to #1365: cleans the right-hand TOC of the consolidated CLI commands.rst page to show only command groups/commands, and adds rediraffe redirects from old per-command pages. Awaiting maintainer re-review; spread/slow test checks fail. |
Update history
| Date | Change |
|---|---|
| merged | |
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
canonical/rockcraft#1365
(confidence 95%)
Earlier attempt at the same docs change; the author confirmed #1379 replaces it and #1365 was closed unmerged with redirect/duplicate-label fixes requested.
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. | |
| #1365 docs: unify cli command references | rockcraft | closed | 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. | |
| #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. | |
| #318 docs: automate CLI reference documentation | rockcraft | merged | Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779. | |
| #293 Improve reference docs for rockcraft commands | rockcraft | open | CLI reference expansion was delivered by PR #318; follow-up consolidation in #1354 is also closed, leaving no active work tracked here. | |
| #105 docs: add commands | rockcraft | merged | Merged PR #105 as commit 68906471, adding the first draft of rockcraft command documentation and resolving issue #101. | |
| #289 docs: expand rockcraft.yaml reference | rockcraft | merged | Merged into main via commit 654c9c01, reorganizing reference docs and expanding the rockcraft.yaml configuration reference across seven files. |