feat: add documentation link in help messages
Metadata
Current evaluation
Merged. Adds documentation links to general and command help messages. Approved by two reviewers, passed CI, and modified six files. Formatting adjustments resolved linter warnings.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
-----
Adds documentation links in general help messages and command help messages.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged. Adds documentation links to general and command help messages. Approved by two reviewers, passed CI, and modified six files. Formatting adjustments resolved linter warnings. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Adds documentation links to general and command help messages, incorporating autoformatting fixes and a linter consistency update. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #298 feat: add documentation link in help messages | craft-cli | merged | Added documentation links to general and command-specific help messages. Merged after approval by two reviewers, modifying five files (+128/-46 lines). Markdown format help was intentionally excluded. | |
| #3954 linters: add help urls | snapcraft | merged | Merged: Added help URLs to linter warnings. Approved by one reviewer and passed CI checks. Modifies seven files. Author notes URLs will be updated once forum posts are integrated into official documentation. | |
| #306 feat: remove code backticks in CLI help messages | craft-cli | merged | Merged following approval by two reviewers and successful CI checks. The update removes code backticks from CLI help messages, closes #303. Changes affect two files with 90 additions and zero deletions. | |
| #288 docs: consolidate external links | rockcraft | merged | Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions. | |
| #291 docs: fix linkcheck issues with documentation | craft-store | merged | Merged after approval and passing all CI checks. Resolved documentation linkcheck issues by fixing broken links, addressing issue #290. Changes modified two files with five additions and two deletions. | |
| #271 feat: display positional args in help | craft-cli | merged | Merged to display positional arguments in help output. Approved by two reviewers, passed checks, and modified three files with 38 additions and 3 deletions. | |
| #154 Improved short help messages. | charmcraft | merged | Merged improvements to short help messages for commands and parameters, updating output per UX suggestions. Approved by two reviewers, passed CI, and modified eight files as part of a broader help overhaul. | |
| #5637 docs: fix CONTRIBUTING.md typos | snapcraft | merged | Merged documentation update correcting typos and internal links in CONTRIBUTING.md. Approved by two reviewers, passed CI checks, and applied with a minimal three-line change. | |
| #257 feat: split the docs url into base and slug | craft-cli | merged | Merged. Splits documentation URLs into base and slug components to improve error reporting. Approved by two reviewers, passed CI checks, and modified three files (+71/-3). | |
| #1063 docs: fix a missing link | rockcraft | merged | Merged a documentation fix adding a missing hyperlink. Approved by four reviewers with a single-line change. The PR was merged despite one failing CI check (snap-tests), as the documentation-only update was deemed low-risk. |