← Back to issue list

docs: refresh icon guidance

View original Github issue

Metadata

Project
charmcraft
Number
#2809
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Docs PR merged as commit 211b4130: rewrote the 'Manage icons' how-to, added icon.svg file paths to plugin migration guides, and trimmed the icon.svg reference to link to the how-to. Resolves #2593 and #2744.

Resolution: closed resolved

Reason: The PR was approved and merged into main as commit 211b4130 ("docs: refresh icon guidance (#2809)"), touching 12 files (+131/-138) of documentation. It explicitly resolves issues #2593 (icon.svg not included in *.charm) and #2744 (icon part docs too hidden), building on the earlier fix in #2711 (037c5b41). The only failing check, Security scan / OSV-scanner, is unrelated to docs changes and did not block the merge.

Evaluated by: mr-cal-bot

No scores available.

Issue body

* Refresh what was previously the 'Manage icons' how-to guide * Add explicit mention of the file path in the plugin migration guides * Remove how-to information from the `icon.svg` reference, instead pointing users to the refreshed how-to. Resolves #2593 and #2744. --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [ ] 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 PR merged as commit 211b4130: rewrote the 'Manage icons' how-to, added icon.svg file paths to plugin migration guides, and trimmed the icon.svg reference to link to the how-to. Resolves #2593 and #2744.
stealth/space-bunny-alpha — closed resolved Merged in #2711, refreshing the Manage icons guide, adding icon.svg paths to plugin migration guides, and linking the reference page to the how-to; resolves #2593 and #2744.
qwen/qwen3.6-35b-a3b — — Merged documentation update refreshing the icon management guide, adding file paths to migration docs, and consolidating reference content. Approved, passed CI, and resolves #2593 and #2744.
qwen/qwen3.6-35b-a3b — — Merged documentation update refreshing icon management guidance, adding explicit file paths to plugin migration guides, and consolidating redundant references. Resolves #2593 and #2744. Approved and merged after passing CI checks.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 95
needs review Updates documentation to refresh the Manage icons guide, adds explicit file paths in migration guides, and consolidates redundant icon reference info. Approved by reviewer, CI passing except minor OSV scanner warning, ready to merge.
qwen/qwen3.6-35b-a3b
Staleness: 10
Complexity: 15
Confidence: 85
needs review Refreshes the Manage icons how-to guide, adds explicit file paths in migration guides, and redirects the icon.svg reference. Approved by one reviewer with one unresolved comment and mostly passing CI.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 85
needs review Updates documentation by refreshing the icon management how-to guide, adding explicit file paths in migration guides, and consolidating redundant reference info. Currently approved by one reviewer with one unresolved comment, all CI checks passing.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 90
needs review Documentation update refreshing the icon management how-to guide, adding explicit file paths in migration guides, and consolidating references. Currently pending maintainer review with all CI checks passing.

Update history

Date Change
updated
updated
updated
updated
updated
updated
created

Related work

  • Related To: canonical/charmcraft#2593 (confidence 98%)

    Issue 'icon.svg is not included in *.charm file' — closed by this PR's documentation of the dump part approach and plugin differences.

  • Related To: canonical/charmcraft#2744 (confidence 98%)

    Docs issue 'adding the icon part to a charm is too hidden away' — resolved by the refreshed Manage icons how-to that PR #2809 supersedes/extends.

  • Likely Fixed By: canonical/charmcraft#2711 (confidence 85%)

    Earlier merged PR (commit 037c5b41) that added plugin differences to the icon guide; #2809 is a follow-up refresh of the same content.

Related issues

Issue Project State Summary Similarity
#2711 docs: mention plugin differences in guide about managing icons charmcraft merged Merged guidance on plugin-specific icon handling in PR #2711 (commit 037c5b41), completing the documentation work for #2593.
83%
#2744 docs: adding the icon part to a charm is too hidden away charmcraft closed Docs gap closed by merged PR #2711 (commit 037c5b41): the Manage icons how-to now documents packaging icon.svg via a dump part, and the icon.svg reference page links to it.
72%