Skip to content

Make README operating-system icons safe for GitHub iOS rendering #71

Description

@cuberhaus

Problem

The GitHub iOS app can fail with a generic "Algo salió mal" error when rendering the README's operating-system lists. The affected markup combines a remote SVG reference definition with reference-style images and escaped underscores in alt text, exercising a fragile native Markdown rendering path.

Scope

  • Replace the Supported OS and WIP list icons with ordinary direct <img> elements referencing repository-owned PNG assets.
  • Store small optimized PNG icons under a descriptive .github/assets/ subdirectory rather than depending on remote SVG or Imgur URLs.
  • Use plain accessible alt text such as Arch, Manjaro, Ubuntu, macOS, and Gentoo; do not escape underscores in image alt text.
  • Remove the obsolete reference-style image usages and definitions for these icons.
  • Preserve the surrounding Supported OS, Window Managers, and WIP content unless it is factually stale.
  • Keep icon dimensions explicit and visually consistent on GitHub web and mobile.

Acceptance criteria

  • README contains no remote SVG image reference for the operating-system lists.
  • The relevant icons use direct local PNG paths and no reference-style image syntax.
  • make check or the repository's focused Markdown validation passes.
  • GitHub web renders every icon and list correctly in light and dark themes.
  • The repository opens successfully in the GitHub iOS app and the README reaches the affected sections without a renderer error.
  • If iOS verification cannot be automated, record the app version and manual verification result in the pull request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationissue-refinedReviewed through /refine-issues; scope and disposition confirmed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions