Skip to content

Suggestion: Update image references from PNG to SVG across documentation #2093

Description

@Sherry520

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 replaced 'Working Directory' with 'Working Tree', as per general terminology #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 (Update diagram font and export SVGs #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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions