docs: format plugin references
Metadata
Current evaluation
Merged in PR #5809 via commit f1e95626e, standardizing plugin-reference docs with “Keys” headings, consistent whitespace and lists, and an updated Maven example.
Resolution: closed resolved
Reason: PR #5809 was approved and merged into main as commit f1e95626e. The documentation formatting and plugin-reference updates are now present in Snapcraft.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #5809 via commit f1e95626e, standardizing plugin-reference docs with “Keys” headings, consistent whitespace and lists, and an updated Maven example. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit f1e95626e (#5809), standardizing plugin reference terminology, whitespace, and lists while updating the Maven example. | |
| 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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1349 docs: normalise plugin references | craft-parts | merged | Merged PR #1349 by maintainer jahn-junior normalised plugin docs across 30 files (+702/-545): whitespace, singular "Example" headings, harmonised Unset markers, and replaced :file:/:command: roles. Merged as commit 022d23cb. | |
| #685 docs: add maven plugin documentation | craft-parts | merged | Merged PR #685 added Maven plugin documentation across 3 files in commit 965a117d; merge commit: 176fb2c7. |