← 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 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.

Suggested action: —

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
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.
qwen3.6-35b-a3b-mtp-q6 — — Merged after rebasing on prerequisite #4272, which resolved ReadTheDocs build failures. The update adds a command reference to the documentation. The author requested maintainer ownership of the ReadTheDocs project to resolve webhook permissions.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#4264 docs: add command reference snapcraft closed Superseded by PR #4267. The maintainer closed this PR due to unintended style changes and rebasing complexity. PR #4267 implements the command reference documentation without the conflicting theme updates.
77%
#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.
77%
#318 docs: automate CLI reference documentation rockcraft merged Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates.
76%
#2432 docs: remove command output example charmcraft merged Merged after two approvals. Removed a command output example from documentation to align with other commands and prevent help text instability. Closes #2375. CI passed except one macOS smoke test, which did not block the merge.
75%
#945 docs: update docs with extra ref anchors craft-parts merged Merged documentation update adding extra reference anchors to support PR #2050. Approved by two reviewers, passed CI checks, and includes a changelog entry.
74%
#1000 docs: Add how-to to override commands in web apps rockcraft merged Merged documentation update adding a how-to guide for overriding commands in web apps across various frameworks. Approved by three reviewers and integrated after passing CI checks.
72%
#5032 docs: add linter reference page snapcraft merged Merged documentation update adding a linter reference page. Approved by two reviewers and merged despite unrelated CI store timeout failures. Changes span two files with 62 added lines.
72%
#4904 docs: add explanation, howto, and reference for components snapcraft merged Merged after approval and passing CI checks. Added explanation, how-to, and reference documentation for components, resolving issue #4857. Unrelated test failures were noted but did not block the merge.
72%
#10 docs: improve README snapcraft-rocks merged Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file.
72%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
72%