Skip to content

docs: add note about bright color and theme support - #9

Merged
seapagan merged 1 commit into
mainfrom
docs/note-bright-compat
Jul 3, 2026
Merged

docs: add note about bright color and theme support#9
seapagan merged 1 commit into
mainfrom
docs/note-bright-compat

Conversation

@seapagan

@seapagan seapagan commented Jul 3, 2026

Copy link
Copy Markdown
Owner

Add a note to the README.md about terminal and theme support for bright color support.

Summary by CodeRabbit

  • Documentation
    • Improved the README with clearer guidance on ANSI bright colour codes, including how they map to terminal palettes and why they may look similar to standard colours in some themes.
    • Expanded terminal compatibility notes to explain that colour appearance can vary across terminals and themes, with an example of pastel-style themes.

Signed-off-by: Grant Ramsay <seapagan@gmail.com>
@seapagan seapagan self-assigned this Jul 3, 2026
@seapagan seapagan added the documentation Improvements or additions to documentation label Jul 3, 2026
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: eebc9884-36ae-4cc3-aef7-b98dd592aa6d

📥 Commits

Reviewing files that changed from the base of the PR and between 834bdb3 and 84409b7.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This change updates README.md documentation, adding an explanatory callout on bright ANSI colour code mapping to terminal palettes and expanding the Terminal Compatibility section to note appearance variance across terminals and pastel themes such as Catppuccin.

Changes

README documentation update

Layer / File(s) Summary
Bright colour documentation
README.md
Adds an important callout explaining bright ANSI SGR code mapping to terminal palettes, and expands the Terminal Compatibility bullet to note theme-dependent appearance variance, including pastel themes like Catppuccin.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

Bright hues hop across the screen,
Terminals paint what themes may mean.
This rabbit scribbled notes with care,
On pastel tones and colours rare.
Hop, hop — the docs are clear and bright! 🐇🎨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarises the documentation update about bright colour handling and theme compatibility.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/note-bright-compat

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

Comment @coderabbitai help to get the list of available commands.

@seapagan
seapagan merged commit b9c72f0 into main Jul 3, 2026
2 checks passed
@seapagan
seapagan deleted the docs/note-bright-compat branch July 4, 2026 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant