Skip to content

README: show the three built-in scenes, with the reference scene as the hero image (#180) - #268

Merged
flyingrobots merged 3 commits into
mainfrom
docs/readme-images
Nov 17, 2026
Merged

flyingrobots merged 3 commits into
mainfrom
docs/readme-images

Conversation

@flyingrobots

@flyingrobots flyingrobots commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

Closes #180

Agent-written documentation, not yet human-reviewed.

What changed

  • docs/images/: three lossless re-encodings (macOS sips -s format png) of Lumen's own renders (lumen render --scene S --width 1280 --height 720 --samples 64 --seed 0, run in the container, exported with devrun --export).
  • README.md: first sentence says what Lumen does, then names Geordi and Bunny; the reference scene is the hero image; a section shows Fixed Point and the canyon, each with alt text, the render command, the image hash and the size; plain cargo for all three, make demo for maintainers with devrun.
  • .gitattributes: docs/images/*.png binary -filter.
  • CHANGELOG.md: the Documentation entry under Unreleased now describes the images (README: show the three built-in scenes, with the reference scene as the hero image #180).
  • docs/reference/scenes.md: the canyon section said no image of it was in the repository; it now links to the README.
  • Checked, unaffected: docs/tutorial.md (its 320 by 180 first image is a different render), docs/README.md, ADR 0009.

Evidence

Lumen's report (scene and image lines), and the committed file decoded by a standard-library Python script (zlib, all five PNG filter types) to raw RGBA8:

Scene Report scene image (SHA-256 of decoded RGBA8) Decoded size, depth, colour type File
reference lumen-reference-scene/4 7d68fa3a...1700a6e 1280x720, 8, 6 (RGBA) 1010810 bytes
fixed-point lumen-fixed-point-scene/2 86cdfd58...fb153 1280x720, 8, 6 682107 bytes
canyon lumen-canyon-scene/1 1bd910dc...56446 1280x720, 8, 6 1285075 bytes

(Full hashes are in the README.) The decoded hash of each committed file equals the image hash Lumen printed; the renders were run twice and gave the same hashes. sips added only sRGB and eXIf (dimensions only) chunks; pixels are unchanged.

  • Each committed image decodes to the pixels whose SHA-256 is the stated hash.
  • Total 2977992 bytes (2.98 MB), under 4 MB.
  • cargo run --locked -q -p xtask -- doc-links in the container: 29 pages, 0 broken links; Gates / doc links green on CI.
  • CHANGELOG has the entry.

Test plan

  1. Re-render: cargo run --release -p lumen -- render --scene canyon --width 1280 --height 720 --samples 64 --out canyon.png (likewise reference, fixed-point) and compare the image line with the README.
  2. Decode a committed PNG to RGBA8 and SHA-256 it; it equals the README hash.

Not verified

  • The images were not viewed on GitHub's renderer or in dark mode; alt text was written from viewing the images.
  • No code changed; the full test suite was not run.

…he hero image

Adds lossless re-encodings of Lumen's 1280x720, 64 spp, seed 0 renders under docs/images/
(2.98 MB in all; each decodes to the pixels of the stated image hash), a README that opens
with what Lumen does and the reference scene, .gitattributes entries so no filter touches
the images, and the changelog entry.

Issue: #180
Agent-Session: 6d1f3b52-7c0e-4b8a-9a41-180c0ffee180
Agent-Tool: Claude Code
@flyingrobots

Copy link
Copy Markdown
Owner Author

WIP: three renders re-encoded and byte-checked, README, .gitattributes, changelog and scenes.md updated, doc-links passes in the container. Next: wait for CI, then rewrite the description.

@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 2 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: bd0a5955-ca03-475c-80af-ef3f0aaf4a6a
Commits

Reviewing files that changed from the base of the PR and between 0c75d9d and 6905e6b.

Files ignored due to path filters: 3

  • docs/images/lumen-canyon-1280x720-64spp.png is excluded by !**/*.png
  • docs/images/lumen-fixed-point-1280x720-64spp.png is excluded by !**/*.png
  • docs/images/lumen-reference-1280x720-64spp.png is excluded by !**/*.png
Files selected for processing: 4

  • .gitattributes
  • CHANGELOG.md
  • README.md
  • docs/reference/scenes.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@flyingrobots
flyingrobots marked this pull request as ready for review November 16, 2026 01:44
@flyingrobots

Copy link
Copy Markdown
Owner Author

CI is green on the head commit; description holds the evidence and test plan. Out of draft.

@chatgpt-codex-connector

Copy link
Copy Markdown
Codex Review Summary: ❌ Failed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ❌ Failed 2026-11-16T01:44:28.545424Z
We couldn’t complete this review. Comment @codex review to try again.
b4ede14 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

…belled abridged

Issue: #180
Agent-Session: 6d1f3b52-7c0e-4b8a-9a41-180c0ffee180
Agent-Tool: Claude Code
Issue: #180
Agent-Session: 6d1f3b52-7c0e-4b8a-9a41-180c0ffee180
Agent-Tool: Claude Code
@flyingrobots
flyingrobots merged commit e456031 into main Nov 17, 2026
13 checks passed
@flyingrobots
flyingrobots deleted the docs/readme-images branch November 17, 2026 14:10
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.

README: show the three built-in scenes, with the reference scene as the hero image

1 participant