OdyTTY Documentation

September 9, 2026 · View on GitHub

Project overview | Website

This index groups current guides, design contracts, and historical evidence. Documents in the source tree may describe unreleased changes; use the matching tag for shipped behavior and the release index for current publication status and corrections.

Documentation maintenance policy defines these scopes and the checks used during release preparation.

Start Here

  • Release notes - concise highlights for each release, including patch releases from v0.10.0 onward.

  • Install guide — setup, updates, checksums, source builds, and troubleshooting.

  • Feature reference — terminal behavior and native workflows.

  • Paste safety — exact warning triggers, dialog choices, shell-controlled bracketed-paste behavior, and cancellation rules.

  • Settings guide — shipped defaults and useful opt-ins.

  • Runtime reference — every setting and command-line surface.

Use And Customize

  • Named profiles - reusable launch contexts, the Profile Manager, defaults, precedence, launch surfaces, and switching.
  • Annotated config — a commented configuration starting point.
  • Keybindings — shortcuts and rebinding.
  • Buttons — the program-defined clickable-output protocol.
  • Accessibility — readability and motion controls.
  • Notifications — bounded OSC progress, completion, and pane-monitor policy.
  • Diagnostics — logs, recovery, and support information.

Visual System

Together these cover the renderer, visual effects, inline media, themes, and scaling behavior.

Architecture And Design

Stabilization And Evidence

These documents distinguish reproducible evidence and executed results from unsupported, skipped, deferred, and unmeasured surfaces.

Packaging And Release

History And Roadmap

Contributing And Security