← Back to issue list

docs: adjust wording and terminal text in tutorial

View original Github issue

Metadata

Project
snapcraft
Number
#5929
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update addressing issue #5896. Added a guardrail to prevent accidental copying of grade and confinement keys in the tutorial. Adjusted terminal and code block formatting for improved semantic clarity.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2700 docs: update tutorial terminal blocks with correct metadata charmcraft merged Merged documentation update standardizing terminal block metadata across tutorial guides. Approved by three reviewers, passed CI, and resolves Jira ticket ISD-5216. Modified six files with 65 line additions.
71%
#6316 docs: improve tutorial based on user testing snapcraft merged Merged documentation improvements to the tutorial based on user experience research feedback. Approved by one reviewer, passed CI checks, and modified two files to refine the guide.
70%