← Back to issue list

docs: improve tutorial based on user testing

View original Github issue

Metadata

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

Current evaluation

Merged docs-only PR applying feedback from two user experience research (UXR) sessions to the Snapcraft tutorial, revising tutorial docs (+56/-85) after maintainer approval; only the OSV-scanner check failed.

Resolution: closed resolved

Reason: PR #6316 was approved by a maintainer and merged into main, delivering the UXR-driven tutorial documentation improvements. The single failing CI job (Security scan / OSV-scanner) did not block the merge, as the change touched documentation files only.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Feedback from two UXR sessions. --- - [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. - [x] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs-only PR applying feedback from two user experience research (UXR) sessions to the Snapcraft tutorial, revising tutorial docs (+56/-85) after maintainer approval; only the OSV-scanner check failed.
stealth/space-bunny-alpha — closed resolved Merged docs-only PR #6316 by medubelko (approved, 1 reviewer): applies feedback from two UXR sessions to the tutorial docs, +56/-85 lines over 2 files, with meta descriptions added. All checks green except OSV-scanner.
stealth/space-bunny-alpha — closed resolved Merged #6231 in commit d8844f4, applying UXR/TA feedback across four tutorial documentation files; this was a docs-only change.
qwen/qwen3.6-35b-a3b — — 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.

Update history

No update history recorded yet.

Related work

  • Superseded By: canonical/snapcraft#6231 (confidence 70%)

    Earlier iteration 'docs: incorporate tutorial feedback' (merged as commit d8844f400, +53/-72) covering the same UXR/TA feedback; #6316 is the follow-up revision of the same docs work.

  • Related To: canonical/snapcraft#5422 (confidence 60%)

    PR that originally added the Snapcraft tutorial that this PR refines based on user testing.

  • Related To: canonical/snapcraft#6107 (confidence 35%)

    Other merged docs-improvement work in the same documentation series around the same period.

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).
80%
#6107 docs: improve the contribution guides more snapcraft merged Merged documentation improvements in snapcraft#6107 via commit aced3d1aa, refining the commit workflow, testing guidance, and link accessibility.
73%
#5586 docs: improve and move setup guides snapcraft merged Merged PR #5586 improved and relocated the Snapcraft setup guides based on internal feedback, landing as commit dacb9c702.
72%