design / rules

design / rules

Rules

v0.12.0 · 01 / 08 · 1 min read · docs/DESIGN.md

One frame. The page is a terminal: a title bar with ⣿ and ⡇, a

  1. One frame. The page is a terminal: a title bar with ⣿ and ⡇, a braille rule, a scrollable body with a braille scrollbar, another rule and a footer with the keys and the reading position. The frame never scrolls away.
  2. The program is the reference. Glyphs, headings, rules, code frames, bullets, quotes and the progress bar are the shapes wr itself draws. If a shape does not exist in the reader, it does not exist here.
  3. Monospace only. Everything, prose included, uses the same monospace stack. There is no second typeface and no reading font.
  4. The terminal’s colors. The palette is the 16 ANSI colors. The accent setting changes headings, links, the scrollbar, selections and the progress bar; the rest stays the terminal’s.
  5. No motion. The TUI redraws; it does not fade, rise or slide. The only animation is the caret the browser draws in an input.
  6. The keyboard first. Every destination and every panel has a key. The mouse works, but nothing requires it.
  7. The content is the same content. Pages are still built from docs/GUIDE.md, docs/DESIGN.md, docs/BENCHMARKS.md, docs/ARCHITECTURE.md, CHANGELOG.md and the generated reference. The shell changed; the files did not.

edit this page on GitHub ↗report a problem ↗