Skip to content

docs: recommend OpenMono Nerd for the terminal - #65219

Draft
iamdavidhill wants to merge 1 commit into
devfrom
terminal-font-docs
Draft

iamdavidhill wants to merge 1 commit into
devfrom
terminal-font-docs

Conversation

@iamdavidhill

Copy link
Copy Markdown
Contributor

Issue for this PR

No issue. This complements #64796, which moves the website and docs to OpenMono.

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Adds a short Terminal font section to the CLI intro (services/site/src/docs/content/cli/index.mdx, /docs/cli/#terminal-font), right after the suggested terminals:

The terminal interface draws its status marks, tool icons, and spinners (blocks and Braille) as text, so they come from your terminal's font. A font without one of them shows an empty box or takes it from another font.

OpenMono Nerd is Anomaly's own terminal font, made for OpenCode. It has every symbol the interface draws, Braille, and the Nerd Fonts icons that shell prompts and command-line tools print, each one cell wide. It is free under the SIL Open Font License 1.1.

Install OpenMono Nerd, then select the family OpenMono Nerd in your terminal:

Then one row each for Ghostty, WezTerm, Kitty, Alacritty, iTerm2 and VS Code, with the settings from the font's README.

  • The download link is not in yet. The font's repository is not public, so the page names no URL. When it is, link the words "Install OpenMono Nerd" in the last sentence above to the font's release page. This PR stays a draft until then: without the link the page tells readers to install a font it does not point to.
  • What the page claims. The interface's own symbols are ordinary Unicode characters, not Nerd Fonts icons: the terminal interface and CLI source use 77 symbols outside ASCII and box drawing, and none is in the private use area. So the page does not say OpenCode needs a Nerd Font. It says what the font covers. All 77 are in OpenMono Nerd 1.000 and one cell wide, with all 256 Braille patterns.
  • One place only. No docs page named a font or a font requirement before this. The Troubleshooting page has no entry on empty boxes or missing symbols, so there is no pointer to add.
  • English only. The current docs (/docs) are English only. The V1 docs (/v1/docs, 18 languages) are the old version's pages and are not changed.
  • No feature flag. Docs only.

How did you verify your code works?

  • bun run check at the root (lint, and typecheck of every package), which the pre-push hook also ran. bun typecheck and bun test in services/site (242 pass).
  • The docs build (bun src/docs/script/build.ts), which checks every link, and the site's full bun run build.
  • The page in Chromium at 1440 px and 390 px, light and dark. The new heading is in Contents. At 390 px the table scrolls inside its own frame and the page does not scroll sideways.
  • The Markdown version of the page (/docs/cli.md) carries the same section.

Screenshots / recordings

Before After
Desktop CLI intro before CLI intro with the Terminal font section
After Light Dark
Desktop Terminal font section, dark
390 px Terminal font section at 390 px, light Terminal font section at 390 px, dark
390 px, the table Settings table at 390 px, light Settings table at 390 px, dark

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant