Suggestion: Update image references from PNG to SVG across documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Review the .asc documentation sources and compare their PNG references with available SVG assets, guided by the SVG migration in #1285 and examples in #1407, #1459, and #1981. Replace references only where a corresponding SVG exists, then run the documentation build to verify the images render correctly.
Written by the indexing model from the issue text.
Description
General overview of your idea.
I noticed that several vector graphics/images in the repository have been updated in SVG format (#1407 #1459 #1981). However, the documentation source files (.asc) are still referencing the legacy PNG versions.
Since we are migrating towards SVG assets for better maintainability (#1285), should we replace all existing .png image references with their corresponding .svg files wherever an SVG version is available?
I'd be happy to submit a Pull Request to help update these references if the maintainers agree with this approach!
What problem will this solve?
-
Inconsistent Asset Usage: It eliminates the discrepancy where newly updated SVG graphics exist in the repository but are ignored during documentation builds.
-
Maintenance Alignment: As encountered in #1407, converting updated SVGs back to PNG is a friction point because contributors often don't know how or lack the tooling to export them properly. Referencing SVGs directly aligns with the project's ongoing SVG migration goals (#1285) and ensures that future graphic updates reflect in the built documentation without requiring manual PNG re-exports.
Have you thought about other solutions?
No response
Do you want to help with this enhancement idea?
Yes
- Dominant language
- CSS
- Stars
- 6.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from progit/progit2
-
Difficulty 1/5 Under an hour Newbie friendliness 87/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
Similar issues
-
documentation tool triaged
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
can1357/oh-my-pi#19608 · 2 comments ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
liberation-data/drivine-python#529 ·
Maintainers usually reply within 1 day
-
automated documentation maintenance
Difficulty 1/5 1-3 hours Newbie friendliness 75/100
github/gh-aw-mcpg#16717 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 2 days