docs: refresh icon guidance#2809
Open
jahn-junior wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes Charmcraft’s icon documentation by replacing the old “Manage icons” how-to with a new “Add an icon to Charmhub” guide, simplifying the icon.svg reference to avoid duplicating how-to content, and updating plugin migration guides to clarify that icon.svg is no longer included by default for non-Charm plugins.
Changes:
- Replaces
docs/howto/manage-icons.rstwith a newdocs/howto/add-an-icon.rstguide and updates the how-to index links accordingly. - Updates plugin migration guides (Poetry/Python/uv) to point to the
icon.svgreference when describing extra files. - Simplifies
docs/reference/files/icon-svg-file.rstby removing the embedded how-to example in favor of linking to the how-to.
Reviewed changes
Copilot reviewed 7 out of 10 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/files/icon-svg-file.rst | Removes embedded “how to include” example; now points users to the how-to for manual packing. |
| docs/howto/migrate-plugins/charm-to-uv.rst | Updates “Include extra files” wording to reference the icon.svg reference. |
| docs/howto/migrate-plugins/charm-to-python.rst | Updates “Include extra files” wording to reference the icon.svg reference. |
| docs/howto/migrate-plugins/charm-to-poetry.rst | Updates “Include extra files” wording to reference the icon.svg reference. |
| docs/howto/manage-icons.rst | Removes the old how-to content (superseded by the new add-an-icon guide). |
| docs/howto/index.rst | Repoints the how-to index and toctree entry from manage-icons to add-an-icon. |
| docs/howto/add-an-icon.rst | Adds the refreshed icon how-to (create/validate/pack/publish icon). |
docs: add redirect docs: fix typo docs: clarify file location docs: add missing meta description docs: add 'validator' to ignore list docs: fix redirect
jahn-junior
force-pushed
the
work/icon-docs/CHARMCRAFT-718
branch
from
July 23, 2026 21:56
b911e14 to
07d5b4d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
icon.svgreference, instead pointing users to the refreshed how-to.Resolves #2593 and #2744.
make lint && make test.