Skip to content

Conversation

ae-openai
Copy link
Collaborator

New style guide:

Headers, primary, and secondary text

  • Headers: Use bold. For markdown with various header levels, leave in the # signs.
  • Primary text: Default.
  • Secondary text: Use dim.

Foreground colors

  • Default: Most of the time, just use the default foreground color. reset can help get it back.
  • Selection: Use ANSI blue. (Ed & AE want to make this cyan too, but we'll do that in a followup since it's riskier in different themes.)
  • User input tips and status indicators: Use ANSI cyan.
  • Success and additions: Use ANSI green.
  • Errors, failures and deletions: Use ANSI red.
  • Codex: Use ANSI magenta.

Avoid

  • Avoid custom colors because there's no guarantee that they'll contrast well or look good on various terminal color themes.
  • Avoid ANSI black, white, yellow as foreground colors because the terminal theme will do a better job. (Use reset if you need to in order to get those.) The exception is if you need contrast rendering over a manually colored background.

(There are some rules to try to catch this in clippy.toml.)

@ae-openai ae-openai changed the title fix: define styles.md and clean up fix: clean up styles & colors and define in styles.md Aug 18, 2025
@ae-openai ae-openai marked this pull request as ready for review August 18, 2025 02:12
@ae-openai ae-openai merged commit 5bce369 into main Aug 18, 2025
15 checks passed
@ae-openai ae-openai deleted the ae/colors branch August 18, 2025 15:26
@github-actions github-actions bot locked and limited conversation to collaborators Aug 18, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants