docs: doc-page banners + demo GIF, README review pass#2
Open
OnlyTerp wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Rob <onerobby@gmail.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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.
Summary
Follow-up to the premium README visuals: adds matching header banners to the four
docs/pages and an animated demo GIF, plus a full repo review (findings below). Docs/assets only — no code touched;test_proxy.pystill passes and all internal markdown/image links resolve.Doc banners — each
docs/*.mdnow opens with a centered 1280×210 banner (same indigo→violet→purple palette + icon), and the now-redundant# TitleH1 was dropped:doc-setup.png,doc-how.png,doc-add.png,doc-trouble.pngunderassets/brand/.Demo GIF (
assets/demo/demo.gif, 64→48-frame seamless loop): a colored Conway glider crawling on a torus inside a terminal window mockup (❯ python3 life.py --pattern glider --color). Wired into the README ## Demo section, replacing the commented-out placeholder.examples/demo/life.pyis intentionally left unfinished (that's the task handed to UltraCode), so I did not modify it or commit a solved version.assets/demo/README.mddocuments this and how to drop in a real recording.Repo review — combed every tracked file. No real secrets (only
REPLACE_WITH_YOUR_*/${ENV_VAR}placeholders inconfig.example.json), no stray/untracked files, no TODO/FIXME/debug prints, no personal paths or emails,.gitignorecorrectly coversconfig.json/*.env/*.log. Only "broken" links pre-fix were the placeholderdemo.gifreferences, now resolved. Nothing needs removing — repo is clean.assets/brand/README.mdupdated to list the new banners and demo GIF.Link to Devin session: https://app.devin.ai/sessions/92667378068c424b84282a40b0290647
Requested by: @OnlyTerp