← Back to issue list

docs: add command reference

View original Github issue

Metadata

Project
snapcraft
Number
#4267
Type
pull request
State
merged
Author
dboddie
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #4267 in commit f06e12eb7, adding the CRAFT-1851 command reference and updating 10 documentation files.

Resolution: closed resolved

Reason: PR #4267 was approved with no unresolved review comments and merged as f06e12eb7. Its prerequisite, PR #4272, had already removed the obsolete documentation submodule.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `pytest tests/unit`? ----- CRAFT-1851

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #4267 in commit f06e12eb7, adding the CRAFT-1851 command reference and updating 10 documentation files.
stealth/space-bunny-alpha — closed resolved PR #4267 by dboddie merged as commit f06e12eb7 (CRAFT-1851), adding a generated command reference under docs/reference/commands.rst plus a CLI doc generator (tools/docs/gen_cli_docs.py).
stealth/space-bunny-alpha — closed resolved Merged #4267 (commit f06e12eb7): adds command reference docs (10 files, +292/-18) for CRAFT-1851, landing after prerequisite #4272 removed an obsolete sphinx submodule; approved by 2 reviewers.
stealth/space-bunny-alpha — closed resolved Merged #4267 (f06e12eb7), adding command-reference docs across 10 files after prerequisite #4272 fixed obsolete-submodule documentation breakage.
stealth/space-bunny-alpha — closed resolved Merged in f06e12eb7: added command reference documentation across 10 files. Prerequisite #4272 (e57f979ed) removed an obsolete docs submodule that broke Read the Docs builds.
stealth/space-bunny-alpha — closed resolved Merged #4267 in commit f06e12eb7, adding command-reference documentation across 10 files. Prerequisite #4272 (e57f979ed) removed an obsolete submodule to restore Read the Docs builds.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged into main after updating the branch to include prerequisite PR #4272, which fixed ReadTheDocs build breakage. The update adds a command reference to the documentation with no coverage impact.

Update history

No update history recorded yet.

Related work

  • Blocked By: snapcraft#4272 (confidence 98%)

    Merged prerequisite commit e57f979ed removed the obsolete submodule that had broken documentation builds.

Related issues

Issue Project State Summary Similarity
#4264 docs: add command reference snapcraft closed Closed unmerged and superseded by #4267, which added the command reference and merged as commit f06e12eb7.
79%
#398 docs: fix link to craft cli craft-store merged Merged PR #398 as commit 2f5e0e0, updating the Craft CLI documentation link after its path changed.
74%
#827 Improve commands docstrings (CRAFT-1204). charmcraft merged Merged PR #827, improving command docstrings across three files for clearer Markdown rendering; merged as f9f1e371.
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%
#318 docs: automate CLI reference documentation rockcraft merged Merged PR #318 in commit ca1b1c20, automating Rockcraft's CLI reference documentation and implementing CRAFT-1779.
74%
#46 docs: basic reference documentation craft-platforms merged Merged foundational Craft Platforms reference documentation in #46 via commit 337c743, adding 187 lines across 16 files.
72%
#746 docs: add remote build how-to and reference docs craft-application merged Merged PR #746 added a common documentation module plus generic remote-build how-to and reference guides for Craft Application.
71%
#945 docs: update docs with extra ref anchors craft-parts merged Merged PR #945 added documentation reference anchors and a changelog entry for canonical/charmcraft#2050 (commit 5a1727ee).
70%
#50 Document commands imagecraft merged Merged PR #50 in commit abff98d, adding automatically generated documentation for Imagecraft’s available commands.
70%