docs: sync stale references with the current codebase#246
Merged
Conversation
CLAUDE.md, the top-level README, and docs/ had drifted from the code.
Every change below was verified against source + CHANGELOG.
CLAUDE.md:
- Drop the removed `--tui` flag (v0.15.0); no-arg is the TUI.
- Fix the TUI module path: `src/tui.rs` -> `src/console/` (colors in
`src/console/colors.rs`).
- Color-coded *borders* -> *bullets* for tool-call status.
- Reframe "single binary" for the Ink-default / ratatui-fallback split
(Ink became default in v0.40.0).
- Document subcommands (mcp/upgrade/sessions) and flags (-r/--afk/-v).
- Add an Architecture section mapping the ignis/src/ module layout.
docs/usage/hooks.md:
- Document all 4 hook events; PreToolUse/PostToolUse were missing
(added in v0.41.0). Add their envelope fields, matcher, and
block/rewrite semantics.
- Landlock ABI V1 / Linux 5.13+ -> ABI V2 / Linux 5.19+ (v0.41.3).
docs/configure/permissions.md:
- The bash sandbox shipped (v0.41-v0.43). Document it (opt-in, /settings
toggle, write/read confinement, sandbox_{read,write}_paths) and drop
it from the roadmap.
docs/configure/telemetry.md:
- Remove the "Anthropic emits no token usage" limitation (fixed in #175;
anthropic.rs parses message_delta into a Usage delta).
docs/usage/commands.md:
- Add /connect, /hooks, /settings (present in slash.rs SLASH_COMMANDS).
- /telemetry now toggles, not read-only.
- Ctrl+D exits on a double press (Ink + native TUI).
docs/configure/mcp.md:
- Per-tool permission rules ARE supported (exact mcp__server__tool
names); only per-server globs are not (rule.rs matches_liberal).
docs/README.md + README.md:
- Index the hooks page (it was orphaned). README: Ctrl+D note and drop
the stale "experimental" label on the now-default Ink frontend.
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
The built-in ratatui TUI is deprecated and no longer actively developed; the Ink frontend is the only actively-maintained UI. IGNIS_FRONTEND=native still works and remains the automatic fallback when Node >=18 is missing. - CLAUDE.md: deprecate ratatui in Build/Run and R2 (TUI Design); reframe the "single binary" note. - README.md: deprecate ratatui in the Install paragraph, the TUI+CLI and Single-binary feature bullets. - CHANGELOG.md: record the deprecation under [Unreleased] -> Deprecated.
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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
CLAUDE.md, the top-levelREADME.md, anddocs/had drifted from the code. This brings them back in line — every change was verified against source + CHANGELOG, not guessed.What was stale, and the fix
CLAUDE.mdcargo run -- --tui(explicit TUI)--tuideleted in v0.15.0; no-arg is the TUIcli/mod.rs:140+ testassert!(!rendered.contains("--tui"))CLAUDE.mdsrc/tui.rssrc/console/colors.rs(Catppuccin Mocha)tui.rsin tree;repl → consolerenameCLAUDE.md●render/tool_block.rs:128,render/blocks.rs:550CLAUDE.mdmain.rs:175-200; CHANGELOG v0.40.0 (#192)CLAUDE.mdcli/mod.rs,lib.rsdocs/usage/hooks.mdhooks/protocol.rsHookEvent::ALL(testlen()==4)docs/usage/hooks.mdsandbox/mod.rs:120let abi = ABI::V2;; v0.41.3 #221docs/configure/permissions.mdbash.rs,tools/mod.rs:105,settings.rsdocs/configure/telemetry.mdanthropic.rsparsesmessage_delta→Usagedocs/usage/commands.md/connect/hooks/settings/telemetrynow toggles; Ctrl+D = double pressconsole/slash.rsSLASH_COMMANDS;app.rs:1146docs/configure/mcp.mdpermissions/rule.rsmatches_liberaldocs/README.mddocs/usage/hooks.mdREADME.mdCtrl+Dexits; "experimental" InkCtrl+Dtwice; Ink is defaultcommands.mdVerification
docs/confirms no lingeringtwo events/ABI V1/on the roadmap/not yet supported/does not emit tokenphrases./hookslisting example was checked againstformat_listinhooks/mod.rs(it does not rendermatcher, so the example omits it).Test plan
docs/configure/permissions.md"Bash sandbox" section and thedocs/usage/hooks.mdPreToolUse/PostToolUse subsections for clarity.