← Back to issue list

Improve reference docs for rockcraft commands

View original Github issue

Metadata

Project
rockcraft
Number
#293
Type
issue
State
open
Author
tigarmo
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

CLI reference expansion was delivered by PR #318; follow-up consolidation in #1354 is also closed, leaving no active work tracked here.

Suggested action: close resolved

Reason: Merged PR #318 (commit ca1b1c20) implemented the requested improvement by automating generated per-command reference pages from Rockcraft's CLI, replacing reliance on bare help output. Follow-up issue #1354 is closed; the current page also retains stale lifecycle wording despite commit e28d53f7 dropping lifecycle commands.

Evaluated by: mr-cal-bot

Impact: 18 Quick Win: 3 Complexity: 28 Confidence: 94 Actionability: 25

Issue body

### What needs to get done The reference for Rockcraft's commands should be improved (see https://github.com/canonical/rockcraft/pull/289#discussion_r1213320532) ### Why it needs to get done Because the text is very bare-bones currently ;)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 18
Quick Win: 3
Complexity: 28
Confidence: 94
Actionability: 25
close resolved CLI reference expansion was delivered by PR #318; follow-up consolidation in #1354 is also closed, leaving no active work tracked here.
qwen/qwen3.6-35b-a3b
Impact: 40
Quick Win: 17
Complexity: 30
Confidence: 70
Actionability: 60
keep open Improve Rockcraft CLI command reference documentation; currently uses bare help output. Related to open issue #1354 for unifying CLI references.
qwen/qwen3.8-27b
Impact: 45
Quick Win: 27
Staleness: 55
Complexity: 40
Confidence: 75
Support Request: 10
close stale Request to improve bare-bones Rockcraft command reference docs; addressed by PR #318 which automated CLI reference doc generation via gen_cli_docs.py
qwen/qwen3.6-35b-a3b
Staleness: 70
Complexity: 15
Confidence: 75
Support Request: 10
needs triage Request to enhance Rockcraft command reference documentation due to currently minimal content. Discussion notes limitations of auto-generated help output and potential build dependencies. Currently inactive for over 7 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 85
Support Request: 5
close stale Request to improve Rockcraft command reference documentation. Currently relies on bare-bones help output, with maintainers noting it lacks detail and raises build dependency concerns. No recent activity or implementation progress.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#318 (confidence 98%)

    Merged PR ca1b1c20 added automated CLI reference generation, producing detailed per-command usage, required arguments, options, and global options.

  • Related To: canonical/rockcraft#1354 (confidence 90%)

    The closed follow-up tracked consolidation of Rockcraft's CLI command references.

  • Superseded By: canonical/rockcraft#1354 (confidence 82%)

    The later consolidation effort superseded remaining organization and build-work concerns about the command reference.

Related issues

Issue Project State Summary Similarity
#318 docs: automate CLI reference documentation rockcraft merged Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.
80%
#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.
76%
#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.
75%
#1117 fix(cli): refer to rockcraft.yaml in expand-extensions help rockcraft closed Docs-only PR correcting the expand-extensions help text to say rockcraft.yaml. Closed unmerged by the author after maintainer @asanvaq noted it duplicated the work in #1103 and #1110; fix still pending in #1103.
74%
#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.
74%
#105 docs: add commands rockcraft merged Merged PR #105 as commit 68906471, adding the first draft of rockcraft command documentation and resolving issue #101.
74%
#1210 fix(commands): reference rockcraft.yaml in extensions help rockcraft closed PR #1210 (fix expand-extensions help to say rockcraft.yaml instead of snapcraft.yaml) was closed unmerged by its author as a duplicate of canonical/rockcraft#1103, which is already approved and CI-passing.
73%
#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.
72%
#1012 docs: maintain reference quadrant rockcraft merged Documentation cleanup was merged in canonical/rockcraft#1012 as commit 26c5d64c, aligning the Explanation landing page, labels, and extension reference titles and headings.
71%
#1111 Fix expand-extensions help text to reference rockcraft.yaml rockcraft closed Closed unmerged as a duplicate of #1103, which included the same rockcraft.yaml help-text correction and additional overview wording fixes.
71%