docs: mark the port as work in progress, drop the placeholder gallery - #5
Merged
Merged
Conversation
A Reddit comment on the Jolt Android/iOS announcement pointed out the README's image gallery reads as Android screenshots at a glance, even with the one-line caption underneath. They are raylib-ios captures of the same scene files, and this port has not been run on Android hardware yet (the RUNBOOK already says so at the top), so the gallery was showing something not yet confirmed. - Drop the embedded gallery (20 images) from the README entirely rather than re-captioning it again. A link to raylib-ios's own README stands in for it until this build has real Android captures to show. - Add an explicit work-in-progress line up front, matching the RUNBOOK's own wording, so the caveat isn't something a reader only finds by reaching the small print under a wall of screenshots. - Soften "What runs today" to "What exists today" and note which part of that is host-tested (`jolt test`) versus written-but-unconfirmed-on-device behaviour (tap/back/flap), instead of stating both in the same present tense. - Fix the Attribution section's "the captures above" line, which pointed at the gallery just removed. No image assets deleted -- only what the README shows. docs/templates/home.html still renders the same gallery on the project site; that's a separate surface this pass didn't touch.
burinc
added a commit
that referenced
this pull request
Sep 7, 2026
Three follow-ups from review on PR #5: - docs/templates/home.html: match the README's work-in-progress framing in the hero (was a softer note about the host not having met a device), and add an explicit disclaimer directly above the demo grid, not just below it, saying none of those captures ran on Android and pointing at raylib-ios. The grid images themselves stay: docs/check-site.sh asserts lorenz.gif and tesseract.gif appear in the built homepage, specifically so an edit to this grid can't silently drop the newest scenes, and stripping the grid the way the README's gallery was stripped would break that gate. Bracketing it with disclaimers before and after is the fix that doesn't fight the site's own checks. - README.md and the homepage both note that Jolt and the libraries this project sits on (raylib-jlt, jolt-lang/nrepl, the pinned raylib revision) are still evolving, so a detail here can go stale between releases, and a version mismatch is worth checking against deps.edn before it's filed as a bug. - Adds CONTRIBUTING.md: an invitation (this is community- and team-built, suggestions and missing-piece reports are welcome) plus an etiquette section adapted from Clojure's own community etiquette guide (https://clojure.org/community/etiquette), linked from a new README Contributing section.
burinc
added a commit
that referenced
this pull request
Sep 7, 2026
Follow-up to #5 (already merged: the README's work-in-progress line and its placeholder-gallery removal). This covers the rest of the same review: - docs/templates/home.html: the hero now leads with the same bold "Work in progress: this has not yet been run on Android hardware" framing as the README, instead of a softer note. The 17-image demo grid is gone entirely, captions and the trailing fps table with it: one of those captures (spirograph) is a literal iPhone screen recording, status bar and all, and the rest are the same raylib-ios origin even where it isn't as visible. The gallery section is now a short paragraph saying so, with a link to raylib-ios's own site for the real captures until this build has Android ones. - docs/check-site.sh: dropped the assertion that the built homepage embeds lorenz.gif and tesseract.gif, since that grid no longer exists. Replaced with a comment on what to restore, and why, once real captures land. Nothing else in the gate depended on the grid. - README.md and the homepage hero both note that Jolt and the libraries this project sits on (raylib-jlt, jolt-lang/nrepl, the pinned raylib revision) are still evolving, so a detail here can go stale between releases, and a version mismatch is worth checking against deps.edn before it's filed as a bug. - Adds CONTRIBUTING.md: an invitation (this is community- and team-built, suggestions and missing-piece reports welcome) plus an etiquette section adapted from Clojure's own community etiquette guide (https://clojure.org/community/etiquette), linked from a new README Contributing section. No image assets deleted, only what the docs and the site homepage show.
burinc
added a commit
that referenced
this pull request
Sep 7, 2026
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.
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
1 participant
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.
Why
A comment on the Reddit announcement thread pointed out that the README's image gallery reads as Android screenshots at a glance, even with the one-line caption underneath it. Those images are raylib-ios captures of the same scene files, and this port has not actually been run on Android hardware yet (
tools/android/RUNBOOK.mdalready says so at the top, in its own blockquote). So the README was showing something not yet confirmed, right at the top, more prominently than the caveat under it.I couldn't fetch the thread directly to quote the comment verbatim (Reddit returns a bot-block page,
blocked by network security, even with the proxy unset and confirmed connecting directly) but the request as relayed was specific enough to act on.Changes
jolt test) from what's written-but-unverified-on-device behavior (tap/back/flap).Not in scope here
docs/templates/home.html(the project site homepage) still renders the same gallery. That's a separate surface this PR doesn't touch — flagging it in case it's worth a follow-up.