docs: unify all CLI command references in one page
Metadata
Current evaluation
Closed unmerged and superseded by canonical/rockcraft#1379, which consolidated CLI references into one grouped commands.rst page and added redirects.
Resolution: closed superseded
Reason: PR #1378 was closed unmerged with two unresolved review comments. Merged PR #1379 delivered the equivalent grouped commands.rst consolidation and redirects.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Fixes canonical/open-documentation-academy#376
The `gen_cli_docs.py` script now writes the docs for each command to a file of its group, so only 3 RST files are generated instead of one per command.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed superseded | Closed unmerged and superseded by canonical/rockcraft#1379, which consolidated CLI references into one grouped commands.rst page and added redirects. | |
| stealth/space-bunny-alpha | — | closed superseded | Closed unmerged; its grouped CLI-reference documentation change was landed through merged PR #1379, with redirects for the old per-command pages. | |
| stealth/space-bunny-alpha | — | closed stale | Closed unmerged: #1365 proposed three grouped CLI-reference pages but was left with requested redirect and Sphinx indentation/duplicate-label fixes; two review comments remained unresolved. |
Update history
| Date | Change |
|---|---|
| closed | |
| updated | |
| created |
Related work
-
Superseded By:
canonical/rockcraft#1379
(confidence 99%)
Merged PR delivered the same CLI-reference consolidation.
-
Duplicate Of:
canonical/rockcraft#1365
(confidence 90%)
Both proposed the grouped CLI command-reference documentation change.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. |