docs: trim README for launch#4
Merged
Merged
Conversation
- Drop synthetic SVG screenshot grid (the demo GIF above the fold already covers it; the SVGs do not match the real TUI rendering) - Drop static tests-count badge (drifts without CI wiring) - Move Trusted Publisher table and release commands to docs/RELEASE.md - Tighten Privacy and Why intros, fix Codex hook explanation
lupuletic
force-pushed
the
cleanup/readme-launch
branch
from
958e8c9 to
a30dcf5
Compare
Textual's compositor resolves ANSI colors to RGB before Rich's SVG export sees them, so passing theme=SVG_EXPORT_THEME to console.export_svg is a no-op — cyan/magenta come out as harsh #00ffff/#ff00ff. Post-process the exported SVG to remap the 16 default-ANSI hex values to the softer monokai-style SVG_EXPORT palette (cyan -> #398280, magenta -> #ff2c7a, green -> #98a84b, etc.) so screenshots look like a real iTerm/Ghostty rendering rather than a 1990s VGA terminal. Also restore a trimmed Screenshots section to the README (3 panels: search, why, AI chat) now that the SVGs faithfully represent the TUI.
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.
Summary
README cleanup and a fix to the demo asset generator so screenshots look like a real terminal.
README
docs/RELEASE.md. Maintainer docs were burying user-facing content.Demo SVG fix
Textual's compositor resolves ANSI colors to RGB before Rich's SVG export sees them, so passing
theme=SVG_EXPORT_THEMEtoconsole.export_svgis a no-op — cyan/magenta come out as harsh#00ffff/#ff00ffinstead of the softer values users actually see in iTerm/Ghostty.Fix in
scripts/generate_demo_assets.py: post-process the exported SVG to remap the 16 default-ANSI hex values to the SVG_EXPORT palette (cyan →#398280, magenta →#ff2c7a, green →#98a84b, etc.). Result: README screenshots now match the real TUI palette.Regenerated
docs/assets/code-recall-{search,why,activity,related,ai-chat}.svgand the demo GIF with the fixed palette.Test plan
README.mdon GitHub and confirm screenshots show soft Claude-cyan and Codex-pink, not pure ANSIdocs/RELEASE.mdlink resolvespython scripts/generate_demo_assets.pyruns clean