docs: adjust wording and terminal text in tutorial
Metadata
Current evaluation
Merged as commit 01356fc85: tutorial docs now guard against replacing grade/confinement and use clearer terminal and code examples.
Resolution: closed resolved
Reason: PR #5929 was approved by two reviewers and merged as commit 01356fc85. It resolved the documentation usability gap tracked from #5896 by adding safer tutorial instructions.
Evaluated by: mr-cal-bot
No scores available.
Issue body
For #5896:
Add a guardrail so that users don't accidentally copy over the `grade` and `confinement` keys.
Other:
Adjust some of the terminal and code blocks to be more semantically appropriate.
---
- [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.
~~- [ ] I've updated the relevant release notes.~~
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 01356fc85: tutorial docs now guard against replacing grade/confinement and use clearer terminal and code examples. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #5929 in commit 01356fc85, adding tutorial guardrails to preserve grade and confinement and clarifying terminal and code-block wording. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs improvements in #5929 via commit 01356fc85, adding tutorial guardrails for grade and confinement and clarifying terminal and code-block wording. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5929 (commit 01356fc85), adding tutorial guardrails against overwriting grade and confinement and clarifying terminal and code-block wording. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5929 via commit 01356fc85, improving tutorial wording and terminal blocks and adding a guardrail against overwriting grade and confinement, addressing #5896. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adjusting tutorial wording and terminal text. Added a guardrail to prevent accidental copying of grade and confinement keys. Approved by two reviewers and passed CI checks before integration. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update addressing #5896. Added a guardrail to prevent accidental copying of grade and confinement keys in the tutorial, and improved semantic formatting for terminal and code blocks. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5896
(confidence 100%)
This documentation PR addressed the tutorial-editing mistake reported in #5896.
Related issues
No related issues found above the similarity threshold.