[codex] Align neo TUI docs with runtime behavior#1
Closed
IYENTeam wants to merge 1 commit into
Closed
Conversation
The Rust native TUI docs still described earlier scaffold plans, missing spec files, copied assets, and nextest-only workflows. Runtime verification also showed the documented sentinel forwarding path was real in neo-mode but blocked by the Node parser before dispatch. This change updates the documentation and stale code comments to match the current implementation, adds theme/keymap specs based on the actual parsers, and lets `senpi --neo -- ...` pass through to the Rust binary.\n\nConstraint: Keep existing TUI behavior except for unblocking the documented sentinel forwarding path.\nRejected: Implement leader-key dispatch and ColorSupport detection | the current runtime intentionally only parses that metadata/hint, so documenting the actual behavior is lower risk.\nRejected: Make screenshot capture use the faux backend | the current script intentionally captures the demo scene; docs were the stale side.\nConfidence: high\nScope-risk: narrow\nTested: cargo fmt --package senpi-neo-tui -- --check\nTested: cargo test --package senpi-neo-tui\nTested: cargo clippy --package senpi-neo-tui --all-targets -- -D warnings\nTested: npx tsx ../../node_modules/vitest/dist/cli.js --run test/suite/regressions/neo-tui-arg-parse.test.ts test/suite/regressions/neo-tui-arg-forwarding.test.ts\nTested: npm run check\nTested: npm run build\nTested: cargo build --release --package senpi-neo-tui --bins\nTested: tmux runtime smoke for Rust demo, faux backend echo, and Node --neo -- --list-themes\nNot-tested: Full screenshot PNG regeneration because it would overwrite checked-in image artifacts and local aha is not installed
Author
|
Superseded by upstream split PRs: code-yeongyu#22, code-yeongyu#23, code-yeongyu#24, code-yeongyu#25. |
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
2 participants
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.
What changed
packages/neo-tuiREADME/AGENTS/screenshot docs with the current Rust runtime instead of the older scaffold plan.docs/theme-spec.mdanddocs/keymap-spec.mdbased on the current Rust parsers and bundled assets.senpi --neo -- ...parsing so flags after the sentinel reachsenpi-neo-tuias documented.Code vs docs decisions
qa.sh,qa-scenarios.json, snapshot fixtures, copied dist assets: corrected docs, because current scripts/assets are the source of truth.ColorSupportdetection and leader-key sequences: documented current behavior; did not implement new features.senpi --neo -- --list-themesruntime failure: fixed code, because docs andsplitNeoArgsalready defined this supported contract.Validation
cargo fmt --package senpi-neo-tui -- --checkcargo test --package senpi-neo-tuicargo clippy --package senpi-neo-tui --all-targets -- -D warningsnpx tsx ../../node_modules/vitest/dist/cli.js --run test/suite/regressions/neo-tui-arg-parse.test.ts test/suite/regressions/neo-tui-arg-forwarding.test.tsnpm run checknpm run buildcargo build --release --package senpi-neo-tui --binshello faux--list-themesthroughsenpi --neo -- --list-themesNot tested
ahais not installed and running the script would overwrite checked-in PNG artifacts.