Repository navigation
Brand: a neobrutalist README and API reference (includes #18) - #19
Merged
Merged
Conversation
- tools/release/chgame_upload_tool.json points at v0.3.0 (release.py writes it; committed after the release, as it says). - README, CLAUDE.md, platform/README.md: the old CH32SerialBoot Boards Manager URL is gone; 0.3.0 is released (2026-10-07), with the casino cart and its SD card zip on the release. - docs/roadmap.md: the release is done; telling users of the old URL is still open. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README opens with an animated banner (the handheld paging through the game menu's box art, the pixel logo turning through the rainbow), link buttons with chgame.website first, palette badges and a Rev0 caution, then says what CHGame is and how to start before the deeper material, which moves into collapsible sections. Credits and special thanks close it. The API reference gets the same look in docs/api/extra.css: teal as the main accent, yellow kept for highlights, ink outlines and hard shadows, the pixel logo in the header, the tree hidden on phones. tools/brand/make.py makes every picture in docs/brand/ (banner, buttons, caution, XOXO, header logo, swatches, social preview); docs/brand/README.md is the palette and the rules. The logo moves from docs/api/ to docs/brand/, and the docs workflow also runs when docs/brand/ changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
# Conflicts: # README.md
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What changes
README. It opens with the brand, then answers "what is it, how do I use it" before the deeper material.
API reference.
docs/api/extra.cssgives it the same look: teal as the main accent, yellow only for highlights, ink outlines and hard shadows, and the pixel logo in the header with a yellow shadow. The tree's arrows and spacing are cleaned up and its sync button is hidden. On phones the tree is hidden and the menu button navigates. It is light only now.Brand kit.
tools/brand/make.pymakes every picture indocs/brand/: banner, buttons, warning, XOXO, header logo, swatches and social preview. Its output is the same on every run.docs/brand/README.mdholds the palette and the rules.docs/api/todocs/brand/, and the docs workflow now also runs whendocs/brand/changes.Includes #18 (the 0.3.0 follow-ups: tool URLs, docs say 0.3.0 is out), merged in with the README conflict resolved to the new README, which already carries #18's wording. It also fixes one more stale "not yet published" sentence in
platform/README.md.Checked
make.pyrun twice gives byte-identical output.After merging
Upload
docs/brand/social.pngunder Settings > Social preview; GitHub takes it only there.🤖 Generated with Claude Code