← Back to issue list

docs: incorporate tutorial feedback

View original Github issue

Metadata

Project
imagecraft
Number
#354
Type
pull request
State
merged
Author
jahn-junior
Labels
Created
Updated
Closed

Current evaluation

Merged documentation updates incorporating tutorial feedback. Approved by a reviewer, passed all CI checks, and modified four files. Changes preempt updates in a related pull request.

Suggested action:

No scores available.

Issue body

Address some of the feedback that was received shortly after the tutorial was written. This preempts some changes I'm making to the init template in https://github.com/canonical/imagecraft/pull/353. [Rendered page](https://canonical-ubuntu-documentation-library--354.com.readthedocs.build/imagecraft/354/tutorials/build-an-ubuntu-image/) --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/imagecraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). ~~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.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation updates incorporating tutorial feedback. Approved by a reviewer, passed all CI checks, and modified four files. Changes preempt updates in a related pull request.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates to the tutorial based on feedback. Changes align with upcoming init template modifications in PR #353. All contribution guidelines and CLA requirements were satisfied.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#6231 docs: incorporate tutorial feedback snapcraft merged Merged documentation updates incorporating tutorial feedback from UXR and a TA. Approved by three reviewers and passed CI checks. Modified four files (+53/-72 lines) to refine project guides.
84%
#826 docs: update CONTRIBUTING.md craft-application merged Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions.
79%
#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.
78%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
78%
#294 docs: add CONTRIBUTING.md craft-store merged Merged addition of CONTRIBUTING.md documentation. Approved by two reviewers and passed most CI checks. Minor discussions about local integration test instructions were noted but did not block the merge.
78%
#1021 docs: prevent transclusion issues craft-parts merged Merged to resolve documentation transclusion issues in downstream applications. Approved by three reviewers, passed CI checks, and modified two files (+12/-15 lines).
78%
#1013 docs: fix typo in tutorial index and academy link rockcraft merged Merged documentation update correcting a repeated tutorial index number and updating an academy link. Approved by three reviewers. Changes span two files (+2/-2 lines). CI passed except snap-tests, which did not block the merge.
78%
#6172 docs: update code blocks snapcraft merged Merged documentation update to correct code blocks following reviewer feedback. Passed linting and unit tests, received two approvals, and was merged despite some failing integration-spread-tests.
77%
#2404 docs: update `CONTRIBUTING.md` charmcraft merged Merged update to CONTRIBUTING.md incorporating changes from reviews in other repositories. Approved by three reviewers with no unresolved comments. All CI checks passed prior to merge.
77%
#288 docs: consolidate external links rockcraft merged Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions.
77%