Skip to content

[codex] Document current neo TUI specs#22

Closed
IYENTeam wants to merge 1 commit into
code-yeongyu:mainfrom
IYEN-AI:codex/neo-tui-docs-specs
Closed

[codex] Document current neo TUI specs#22
IYENTeam wants to merge 1 commit into
code-yeongyu:mainfrom
IYEN-AI:codex/neo-tui-docs-specs

Conversation

@IYENTeam

@IYENTeam IYENTeam commented May 25, 2026

Copy link
Copy Markdown

What changed

  • Added the missing packages/neo-tui/docs/theme-spec.md and packages/neo-tui/docs/keymap-spec.md files referenced by the package docs.
  • Updated packages/neo-tui/README.md and packages/neo-tui/AGENTS.md to match the current Rust implementation:
    • bundled themes/keymap are embedded with include_str!, not copied into dist
    • default verification is cargo test; cargo nextest is optional
    • keymap dispatch is single-key today; leader metadata is parsed but not dispatched
    • theme true-color support is a parsed option hint, not terminal detection
    • Ctrl+D and history navigation docs now match app behavior

Why

The docs mixed current runtime facts with older scaffold-plan claims, which made the native Rust TUI harder to maintain safely.

Validation

  • git diff --check
  • pre-commit hook ran npm run check

Not tested

  • Runtime behavior, because this PR is documentation-only.

Summary by cubic

Add packages/neo-tui/docs/theme-spec.md and packages/neo-tui/docs/keymap-spec.md, and update packages/neo-tui/README.md and packages/neo-tui/AGENTS.md to match the current Rust TUI. Docs now reflect embedded assets via include_str!, default cargo test, single-key dispatch (leader parsed but not dispatched), true‑color as a parsed hint, and correct keybindings (Ctrl+D, history); docs-only change.

Written for commit 8f15dec. Summary will update on new commits. Review in cubic

The Rust native TUI docs referenced spec files that were never checked in and still described copied dist assets, nextest-only testing, ColorSupport detection, and leader dispatch that do not match the implementation. Add the missing specs and update the package README/AGENTS guidance to reflect the current parser and build behavior.\n\nConstraint: Keep this PR documentation-only; do not add new runtime features for parsed-but-unused metadata.\nRejected: Implement leader-key dispatch and ColorSupport detection | out of scope for correcting documentation drift.\nConfidence: high\nScope-risk: narrow\nTested: git diff --check\nNot-tested: Runtime tests; documentation-only change
@code-yeongyu

Copy link
Copy Markdown
Owner

[sisyphus-bot] Thanks for documenting the neo TUI specs here, IYEN. Unfortunately this PR no longer has a target: packages/neo-tui and the --neo flag/binary were fully removed from main in commit 44ff816 (2026-05-26, "refactor(coding-agent): remove neo tui flag and binary"), and that removal is now locked in by the neo-flag-removal regression test. Since the spec/doc files this PR adds describe a package that no longer exists in the tree, there is nothing left to merge them against, so I'm closing this as obsolete. If neo-tui is ever reintroduced, you're very welcome to reopen or rework this against the new code.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants