Improve reference docs for rockcraft commands
Metadata
Current evaluation
Request to improve bare-bones Rockcraft command reference docs; addressed by PR #318 which automated CLI reference doc generation via gen_cli_docs.py
Suggested action: close stale
Reason: PR #318 'docs: automate CLI reference documentation' implemented the requested improvement by creating tools/docs/gen_cli_docs.py which generates structured reference pages from command definitions. The docs/reference/commands.rst file now includes auto-generated lifecycle, extensions, and other command references, directly addressing the 'bare-bones' concern raised in the issue.
Impact:
45
Quick Win:
27.0
Staleness:
55
Complexity:
40
Confidence:
75
Support Request:
10
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 |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
45
Quick Win:
27.0
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
20
Confidence:
70
Support Request:
0
|
close stale | Improve Rockcraft command reference documentation beyond basic help output. Current docs are too minimal and risk build dependencies. Open, awaiting documentation updates. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/rockcraft#318
(confidence 80%)
PR #318 automated CLI reference documentation, directly addressing this issue's request to improve command reference docs
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1354 CODA: unify all CLI command references in one page | rockcraft | open | Documentation task to consolidate Rockcraft CLI command references into a single page. Assigned to @0xzoowa, marked as duplicate of canonical/open-documentation-academy#376. | |
| #289 docs: expand rockcraft.yaml reference | rockcraft | merged | Merged after three reviewers approved, the PR reorganized the documentation reference section and expanded the rockcraft.yaml reference guide, modifying 7 files. | |
| #105 docs: add commands | rockcraft | merged | Merged documentation adding rockcraft commands, resolving issue #101. After initial review requested changes, the maintainer coordinated with reviewers and merged the first draft. |