Skip to content

docs(guide): drop the raylib-ios screenshots from both guides - #7

Merged
burinc merged 1 commit into
mainfrom
docs/guide-screenshots-cleanup
Sep 7, 2026
Merged

burinc merged 1 commit into
mainfrom
docs/guide-screenshots-cleanup

Conversation

@burinc

@burinc burinc commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Why

Follow-up to #5 and #6: docs/guide/porting-an-example.html on the live site still had raylib-ios screenshots, one with no caveat at all and one captioned "running on the phone" as if it were fact. Checking its sibling guide, performance-on-a-phone.md, turned up two more of the same, even though that page's own opening paragraph already says every number came off the sibling build, not Android. The images just weren't covered by that sentence.

(These were missed in the earlier passes because a grep ... docs/guide/*.md docs/guide/*.html in this session hit a zsh glob-no-match on *.html, which aborted the whole command before the .md half ever ran. Re-ran it properly this time.)

Changes

  • docs/guide/porting-an-example.md: removed the opening spirograph.png (no caveat at all) and the four-image "running on the phone" block. Kept the factual content each caption carried (screen dimensions, the no-new-bindings count) as plain text.
  • docs/guide/performance-on-a-phone.md: removed its two embedded images (spirograph.gif, the penrose/kaleidoscope stills). Their caption numbers are already in the tables directly below each, so nothing is lost.
  • docs/site.edn: updated the :asset-dirs comment, which claimed the images were "referenced from the homepage and the guides" — no longer true after this and the last two PRs. Says what's actually there now.

A repo-wide grep for images/, .gif and .png across README.md, CONTRIBUTING.md, docs/guide/*.md and docs/templates/*.html now returns nothing. No image files deleted, only what the docs show.

Same cleanup as #5 and #6, extended to the two guide pages, which an earlier
grep missed because a zsh glob with no match (docs/guide/*.html, which
doesn't exist) aborted the whole command before it reached the .md files
that do.

- docs/guide/porting-an-example.md: the opening spirograph.png had no
  caveat of any kind, and the four-image block further down was captioned
  "running on the phone", stated as fact rather than sibling-build fact.
  Both are raylib-ios captures. Removed, keeping the factual content each
  caption carried (screen dimensions, no-new-binding count) as plain text.
- docs/guide/performance-on-a-phone.md: this guide's own opening paragraph
  already says every number came off the sibling build, not Android, which
  is exactly right, but its two embedded images (spirograph.gif, the
  penrose/kaleidoscope stills) were never covered by that sentence. Removed
  both; the numbers in their captions are already in the tables directly
  below each, so nothing is lost.
- docs/site.edn: the :asset-dirs comment claimed docs/images was
  "referenced from the homepage and the guides", which stopped being true
  across three separate commits now. Updated to say what's actually there:
  raylib-ios captures, unreferenced everywhere in this repo's docs, kept
  configured so an Android capture dropped in later just works.

No image files deleted, only what the docs show. A repo-wide grep for
images/, .gif and .png across README.md, CONTRIBUTING.md, docs/guide/*.md
and docs/templates/*.html now returns nothing.
@burinc
burinc merged commit 4e36c6f into main Sep 7, 2026
6 checks passed
@burinc
burinc deleted the docs/guide-screenshots-cleanup branch September 7, 2026 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant