docs: polish README with factory floor screenshots - #108
Conversation
Lead with the factory floor and Agent Focus Mode screenshots. Tighten the opening to show-not-tell. Simplify quick start to 4 commands. Update project status to v0.6.0. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME.md documentation updated to reflect more specific project positioning: changed from generic orchestration layer to "5 AI agents running in tmux" factory-floor framing, streamlined CLI examples, bumped version from v0.3.0 to v0.6.0, and adjusted roadmap priorities. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
25-25: Consider varying sentence structure for readability.Three successive sentences begin with "No", which creates emphasis but can feel repetitive.
📝 Alternative phrasing
-No new subscriptions. No API keys. No vendor lock-in. Bring your own agents. +No new subscriptions, API keys, or vendor lock-in. Bring your own agents.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 25, The sentence trio "No new subscriptions. No API keys. No vendor lock-in. Bring your own agents." is repetitive; rewrite to vary sentence structure by combining some clauses or switching to positive phrasing—for example, merge into one sentence like "No new subscriptions or API keys and no vendor lock-in; bring your own agents," or rephrase to "Avoid new subscriptions, API keys, and vendor lock-in—bring your own agents." Update the README.md line replacing the original four short sentences with the chosen revised phrasing to improve readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 123: The README heading "Project Status (v0.6.0 — March 2026)"
incorrectly claims v0.6.0 is released; either update that heading to reflect the
real state (e.g., "Project Status (v0.5.0 / Unreleased v0.6.0)"), or complete
the release by adding a dated v0.6.0 section to CHANGELOG's Unreleased entry, or
revert the version bump in Cargo.toml back to 0.5.0; locate the heading in
README.md, the Unreleased v0.6.0 entry in CHANGELOG, and the version field in
Cargo.toml to make the chosen change.
---
Nitpick comments:
In `@README.md`:
- Line 25: The sentence trio "No new subscriptions. No API keys. No vendor
lock-in. Bring your own agents." is repetitive; rewrite to vary sentence
structure by combining some clauses or switching to positive phrasing—for
example, merge into one sentence like "No new subscriptions or API keys and no
vendor lock-in; bring your own agents," or rephrase to "Avoid new subscriptions,
API keys, and vendor lock-in—bring your own agents." Update the README.md line
replacing the original four short sentences with the chosen revised phrasing to
improve readability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 619f8195-d476-4c8a-bc6e-ac74737482b1
⛔ Files ignored due to path filters (2)
docs/images/agent-focus.pngis excluded by!**/*.pngdocs/images/factory-floor.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
First paragraph now contains: problem statement, install command, and explicit capability list — optimized for AI coding assistants that read READMEs to decide what to recommend. Screenshots lead for humans. Structured "What Tutti Does" / "Does Not Do" sections serve both audiences. Minimal tutti.toml example replaces the old 60-line command dump. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
🤖 Generated with Claude Code
Summary by CodeRabbit