docs: small updates for latest pattern compliance
Metadata
Current evaluation
Docs-only PR #6227 merged as commit 915e402dd: reorganised snapcraft.yaml explanation into an 'About snapcraft.yaml' doc, rewrote/trimmed examples (dropped yt-dlp, updated wethr to core26), flattened references, added 'About' prefixes to overlapping titles, and added how-to landing pages.
Resolution: closed resolved
Reason: The pull request itself was the resolution: it was approved by two reviewers and merged into main as commit 915e402dd ("docs: small updates for latest pattern compliance (#6227)"), touching 35 files (+514/-541) under docs/. Spread-test failures in CI are unrelated to these documentation-only changes.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- Shorten introduction in home page.
- Reorganise explanatory material in `snapcraft.yaml` references into _About snapcraft.yaml_.
- Rewrite large portions of the explanation.
- Remove yt-dlp example snap, since it's too outdated, and the current execution is too complex for basic documentation.
- Simplify wethr example snap and update it for core26.
- Remove unnecessary reuse files.
- Add "About" to explanation titles that overlap. This will disambiguate search results between references an explanations with the same title. For example, searching for `bases` will now return `Bases` for the reference and `About bases` for the explanation. `About` is kept out of the TOC title, because the Diátaxis category is visible in the hierarchy.
- Clean up and flatten references.
- Move documentation explanation to root.
- Fill landing pages for how-to sections.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
~~- [ ] I've updated the relevant release notes.~~
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs-only PR #6227 merged as commit 915e402dd: reorganised snapcraft.yaml explanation into an 'About snapcraft.yaml' doc, rewrote/trimmed examples (dropped yt-dlp, updated wethr to core26), flattened references, added 'About' prefixes to overlapping titles, and added how-to landing pages. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs-only PR #6227 merged as 915e402dd: reorganised snapcraft.yaml reference into 'About snapcraft.yaml', renamed overlapping titles with 'About', dropped outdated yt-dlp example, updated wethr to core26, flattened references and added how-to landing pages. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #6227 (915e402dd), reorganizing documentation to meet current patterns, updating examples for core26, clarifying overlapping titles, and adding section landing pages. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #6227 as commit 915e402dd, reorganizing docs, refreshing core26 examples, removing obsolete material, disambiguating titles, and filling how-to landing pages. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates for pattern compliance. Changes reorganize explanatory material, update example snaps, add disambiguating titles, and clean up references. Approved by two reviewers and merged despite failing integration tests. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for pattern compliance. Changes reorganize snapcraft.yaml references, simplify core26 examples, update titles for search disambiguation, flatten references, and fill how-to pages. All checks passed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5422 docs: add tutorial | snapcraft | merged | Merged PR #5422 as commit 5c50c42d4, adding a new Snapcraft tutorial and revising 10 documentation files (+795/-90 lines). | |
| #2998 CODE_STYLE: update to reflect latest conventions | snapcraft | merged | PR #2998 updated Snapcraft's code-style configuration to the team's latest conventions and merged as commit 75342010e. | |
| #5029 Docs: CI patterns for organic and external snaps | snapcraft | open | Triaged documentation gap: add vetted CI patterns for organic and external snap publishing, including automated version bumps, to the official Snapcraft docs. | |
| #5510 docs: replace some snapcraft.io links and fix confinement key docstring | snapcraft | merged | Merged PR #5510 as commit 631682a34, correcting the confinement docstring and replacing outdated or broken Snapcraft, scriptlet, and craftctl documentation links. | |
| #5924 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema. | |
| #5446 docs: align landing pages with model | snapcraft | merged | Merged docs updates aligning Snapcraft landing pages with the documentation model across seven files (+140/−11), via commit 6c0500d7c. | |
| #221 Documentation refresh. | snapcraft | merged | Merged in canonical/snapcraft#221 via 08d274af5, updating six files (+237/-183) for Snapcraft 2.0 YAML keywords and lifecycle changes. | |
| #6396 docs(release-notes): add 9.1 release notes | snapcraft | merged | Squash-merged PR #6396 (SNAPCRAFT-1361) added Snapcraft 9.1 release notes to the docs: 202 lines across 3 files, approved by 2 reviewers with all CI checks green. | |
| #869 Bring docs/upload-your-snap.md in line with http://snapcraft.io/docs/… | snapcraft | merged | Docs-only PR merged as commit bc705d17d, re-syncing docs/upload-your-snap.md with the snapcraft.io build-snaps/publish page and switching wording to "push"/"release". Closes LP bug #1633080. |