docs: format plugin references
Metadata
Current evaluation
Merged documentation updates standardizing plugin reference formatting. Changes replace Keywords with Keys, align whitespace, standardize list formatting, and update the Maven example. Approved by two reviewers and passed CI checks.
Suggested action: —
No scores available.
Issue body
- [X] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [X] Have you successfully run `make lint`?
- [ ] Have you successfully run `make test`?
---
* Replace 'Keywords' with 'Keys'
* Standardize whitespace across files
* Make lists consistent in the 'How it works' sections
* Update the maven plugin's example
I'll standardize the "Default" values when https://github.com/canonical/craft-parts/pull/1349#discussion_r2400061830 is resolved.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates standardizing plugin reference formatting. Changes replace Keywords with Keys, align whitespace, standardize list formatting, and update the Maven example. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update formatting plugin references. Changes replace 'Keywords' with 'Keys', standardize whitespace, align lists, and update the maven plugin example. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update formatting plugin references. Replaced 'Keywords' with 'Keys', standardized whitespace, aligned lists in 'How it works' sections, and updated the maven plugin example. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #685 docs: add maven plugin documentation | craft-parts | merged | Merged documentation update adding Maven plugin configuration and usage details. Approved by four reviewers, the change modifies three files with 57 added lines. | |
| #1349 docs: normalise plugin references | craft-parts | merged | Documentation references for plugins were normalized across 30 files by standardizing whitespace, headings, and formatting roles. The changes were approved by two reviewers, passed all CI checks, and successfully merged. | |
| #723 docs: document the .NET plugin | craft-parts | merged | Merged documentation update adding reference material for the .NET plugin. Approved by two reviewers, passed CI checks, and added 90 lines across two files. | |
| #971 docs: update docstring for maven plugin | craft-parts | merged | Merged after approval by two reviewers. Updated maven plugin docstring. Minor lint false positive deferred to another PR, and a wordlist update was requested. Successfully integrated. | |
| #711 feat(docs): make plugin reference | craft-parts | merged | Merged documentation update to establish a plugin reference. Approved by two reviewers, introducing 65 lines across two files. Addresses CRAFT-2680. | |
| #3070 plugins v2: update plugins so they have a similar behavior | snapcraft | merged | Merged after reviewer approval and passing CI. Standardized plugin behavior by removing invalid minitems usage, eliminating prefix setup and default build type concepts, and correcting docstring formatting across 13 files. | |
| #1285 docs: add docs on maven's version rewriting feature | craft-parts | merged | Merged documentation update detailing Maven's version rewriting feature in the maven-use plugin. Approved by two reviewers, passed all CI checks, and added 26 lines explaining the updated version selection logic. | |
| #1181 docs: remove instances of 'v2' from plugin intros | rockcraft | merged | Merged documentation update removing deprecated 'v2' references from plugin introspection and renaming the plugin index to Plugins. Approved by three reviewers, passed CI checks, and applied across three files. | |
| #722 docs: document the Ant plugin | craft-parts | merged | Merged documentation update for the Ant plugin. Approved by two reviewers with minor feedback regarding the plugin build path. Changes span four files, adding 93 lines and removing 2. | |
| #1540 docs: reduce instances of 'v2' in plugin references | craft-parts | open | Documentation cleanup removing 'v2' from plugin references across 2 files (+6/-6 lines). Approved by 2 reviewers with 1 unresolved comment; CI passing. |