docs: automate CLI reference documentation
Metadata
Current evaluation
Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after correcting US to UK spelling conventions. The pull request automates CLI reference documentation generation, resolving CRAFT-1779 and publishing updated docs. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #398 docs: fix link to craft cli | craft-store | merged | Merged a documentation fix updating a broken Craft CLI link after a path change. Approved by one reviewer, passed CI checks, and modified one file. | |
| #5572 fix(docs): remove obsolete CLI reference pages after generation | snapcraft | merged | Merged a fix that automatically removes obsolete CLI documentation files after regeneration, preventing build errors. Approved by reviewers, passed CI checks, and closed the related issue. | |
| #4267 docs: add command reference | snapcraft | merged | Merged after two approvals and passing CI. Added command reference documentation across 10 files. Required merging prerequisite PR #4272 to fix ReadTheDocs builds before updating the branch and finalizing the merge. | |
| #117 docs: add git inspectors reference documentation | fetch-service | merged | Merged documentation update adding reference material for git inspectors. Approved by two reviewers and resolves CRAFT-2639. | |
| #156 docs: update yaml reference | imagecraft | merged | Merged following approval and successful CI checks. Automates the imagecraft.yaml reference documentation using Kitbash, extracting content from docstrings in PR #153. Modified 5 files with +134/-210 lines. | |
| #1000 docs: add reference document for the ConfigService | craft-application | merged | Merged documentation update adding a reference guide for the ConfigService. Approved by two reviewers with all CI checks passing. The change adds 118 lines across six files and resolves CRAFT-4499. | |
| #778 docs: reference docs for remote builds | rockcraft | merged | Merged documentation update adding reference guides for remote builds, complementing autogenerated command docs and resolving issue #597. Approved with minor template discussion. Changes add 51 lines across two files. | |
| #604 docs: update inspectors reference | fetch-service | merged | Merged documentation update adding references for undocumented inspectors, reconciling docs with actual behavior, and normalizing style. Approved by one reviewer, passed CI checks, and modified 38 files. | |
| #404 docs: add an explanation of parts | craft-parts | merged | Merged documentation update explaining parts, adding 628 lines across nine files. Approved by one reviewer, references CRAFT-1612, and was finalized after initial feedback collection. |