← Back to issue list

docs: automate CLI reference documentation

View original Github issue

Metadata

Project
rockcraft
Number
#318
Type
pull request
State
merged
Author
dboddie
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.

Resolution: closed resolved

Reason: PR #318 was approved and merged, with commit ca1b1c20 generating the CLI reference automatically. The change updated five documentation files.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ----- CRAFT-1779 https://canonical-rockcraft--318.com.readthedocs.build/en/318/reference/commands/

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.
stealth/space-bunny-alpha — closed resolved Merged PR #318 (commit ca1b1c20) to generate CLI reference documentation automatically, implementing CRAFT-1779 and updating five files.
stealth/space-bunny-alpha — closed resolved Merged #318 (ca1b1c20), automating CLI reference documentation generation for CRAFT-1779.
qwen/qwen3.6-35b-a3b — — Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates.
qwen3.6-35b-a3b-mtp-q6 — — Merged. Automates CLI reference documentation generation. A reviewer noted a US-to-UK spelling correction required in the document, which was applied prior to merge. The change successfully implements automated docs generation.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
80%
#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.
80%
#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.
79%
#105 docs: add commands rockcraft merged Merged PR #105 as commit 68906471, adding the first draft of rockcraft command documentation and resolving issue #101.
77%
#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.
77%
#682 docs: fix typo rockcraft merged Merged rockcraft#682 (commit 371bc723) fixing a one-line documentation typo; approved by 3 reviewers, CLA signed, merged.
75%
#123 add how-to guide for "building docs" rockcraft closed Added a guide for building Rockcraft documentation locally in PR canonical/rockcraft#126, merged as commit 68a7abda.
74%
#4267 docs: add command reference snapcraft merged Merged PR #4267 in commit f06e12eb7, adding the CRAFT-1851 command reference and updating 10 documentation files.
74%
#1082 fix: reference slug path in for rockcraft.yaml #2 rockcraft merged Merged in canonical/rockcraft#1082 via commit cae91c7d, correcting the CLI’s rockcraft.yaml reference link to the documentation slug rockcraft-yaml.
73%
#297 docs: rockcraft.yaml reference rockcraft closed Redirected to craft-parts documentation for `organize`; no Rockcraft PR or commit fixed the missing in-tree reference, and documentation integration was only planned.
73%