Write the TUI behavior spec, retire finished migration docs - #377
Merged
Conversation
docs/TUI.md is a normative, code-verified spec for the OpenTUI shell: layout, overlays, selectors, the palette, the prompt box, and scroll/mouse behavior. It replaces the interaction-contract and layout-constitution docs (harvested into it) and the readiness/signoff/cutover/freeze/spike docs, which recorded a migration that has already landed. References to the deleted docs are updated to point at docs/TUI.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/TUI.md: a normative, code-verified behavior spec for the OpenTUI shell — layout/chrome, overlays and dismissal, selectors/pickers, the command palette and model picker, the prompt box, and scrolling/mouse/key macros.src/tui-opentui/*source (geometry resolver, shell key handling, gate wiring, palette, product host, prompt input, clipboard, log sink). A few claims that could not be verified are called out explicitly as open questions at the end of the doc, rather than asserted as fact.docs/tui-cutover-readiness.md,docs/tui-tty-signoff.md,docs/tui-migration-cutover.md,docs/tui-ink-freeze.md,docs/plans/opentui-spike-report.md,docs/plans/opentui-platform-wave2.md,docs/plans/tui-layout-scroll-platform.md.docs/tui-interaction-contract.mdanddocs/tui-layout-constitution.md— their still-true content is folded intodocs/TUI.mdin present tense.AGENTS.md,docs/PRODUCT.md,docs/tui-opentui-packaging.md, andsrc/tui-opentui/geometry/zones.ts; addsdocs/TUI.mdto the AGENTS.md doc index.docs/adr/opentui-binding.md(historical ADR) anddocs/tui-opentui-packaging.md(packaging, different concern) in place aside from reference fixes.Verification
bun run typecheck— passesbun run build— passesbun run test— 4038 pass, 0 fail (308 files)