docs: sharpen README hero copy, add real TUI screenshot, restructure setup guide Punches up the intro to read as a confident pitch instead of a dry spec summary, while keeping every claim backed by what's actually in the repo. Embeds an actual kairos tui screenshot (docs/assets/tli-search-evidence.svg, captured via Textual's headless Pilot against real ingested fixtures) so the interface is shown, not just described. Restructures Quick Start into Prerequisites -> Install -> CLI -> TUI so it reads as a setup guide rather than one long undifferentiated command block, and folds the old standalone "Terminal Lineage Interface (alpha)" section into it to remove duplicated install instructions. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> - #1
Merged
Conversation
…setup guide Punches up the intro to read as a confident pitch instead of a dry spec summary, while keeping every claim backed by what's actually in the repo. Embeds an actual kairos tui screenshot (docs/assets/tli-search-evidence.svg, captured via Textual's headless Pilot against real ingested fixtures) so the interface is shown, not just described. Restructures Quick Start into Prerequisites -> Install -> CLI -> TUI so it reads as a setup guide rather than one long undifferentiated command block, and folds the old standalone "Terminal Lineage Interface (alpha)" section into it to remove duplicated install instructions. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
📝 WalkthroughWalkthroughREADME content is revised to present KAIROS as a local-first workspace, expand quick-start instructions for CLI and TUI usage, document the ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 75-78: Update the Prerequisites statement in README.md to qualify
the no-network requirement: clarify that network access may be needed for git
clone and pip install during setup, but is not required after installation. Keep
the existing Python version and other prerequisite claims unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 30226931-059d-464b-9917-6a78e9a8e802
⛔ Files ignored due to path filters (1)
docs/assets/tli-search-evidence.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
Comment on lines
+75
to
+78
| ### Prerequisites | ||
|
|
||
| - Python 3.12 or newer | ||
| - Nothing else. No database server, no API key, no Docker, no network access required at any point. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Qualify the “no network access” prerequisite.
A fresh setup below requires network access for git clone, and pip install -e ".[dev]" may need to download dependencies. Change this to state that no network is required after installation.
Suggested wording
-- Nothing else. No database server, no API key, no Docker, no network access required at any point.
+- Nothing else. No database server, API key, or Docker is required; after installation, KAIROS does not require network access.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Prerequisites | |
| - Python 3.12 or newer | |
| - Nothing else. No database server, no API key, no Docker, no network access required at any point. | |
| ### Prerequisites | |
| - Python 3.12 or newer | |
| - Nothing else. No database server, API key, or Docker is required; after installation, KAIROS does not require network access. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 75 - 78, Update the Prerequisites statement in
README.md to qualify the no-network requirement: clarify that network access may
be needed for git clone and pip install during setup, but is not required after
installation. Keep the existing Python version and other prerequisite claims
unchanged.
6 tasks
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.
What does this change?
Checklist
ruff format --check src testspassesruff check src testspassespyrightpasses with zero errorspytestpasses, and I added/updated tests for the behavior changenon-goals list
docs/cli.mdand/ordocs/architecture.mdif this changes command behavior, schema, or provenance guaranteesHow was this tested?
Summary by CodeRabbit