Skip to content

docs: polish README with factory floor screenshots - #108

Merged
nutt-adam merged 3 commits into
mainfrom
docs/readme-polish
Mar 21, 2026
Merged

docs: polish README with factory floor screenshots#108
nutt-adam merged 3 commits into
mainfrom
docs/readme-polish

Conversation

@nutt-adam

@nutt-adam nutt-adam commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Lead with factory floor + Agent Focus Mode screenshots — show, don't tell
  • Tighten opening to 4 lines + 2 images instead of 60-line command dump
  • Simplify quick start to 4 commands
  • Update project status to v0.6.0
  • Move full command reference below the fold

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Refined project description with enhanced factory-floor framing and Agent Focus Mode screenshots
    • Streamlined installation guide with essential example commands
    • Version bumped to v0.6.0
    • Clarified operator responsibilities and core workflow
    • Updated feature roadmap: removed planned web dashboard UI, added image upload capability for remote agent context

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>
@coderabbitai

coderabbitai Bot commented Mar 21, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@nutt-adam has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 58 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: bc8e072e-0419-471f-9207-8549f939ef2b

📥 Commits

Reviewing files that changed from the base of the PR and between f1a8ab0 and bfe7598.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

README.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

Cohort / File(s) Summary
Documentation Updates
README.md
Revised project description with factory-floor positioning, replaced extensive CLI subcommand catalog with minimal quick-start examples, updated version to v0.6.0, refined "The Problem" section, and adjusted roadmap by removing dashboard/WebSocket items and adding image upload feature.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 The README now gleams with clarity bright,
Five agents in tmux, a factory-floor sight!
Simpler examples, version bumped high,
A roadmap refreshed as the roadrunner flies! 🏃‍♂️

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is missing critical required sections from the template: no Versioning checklist (Cargo.toml, CHANGELOG.md), no SemVer choice, no Validation checklist, and no Release section with tag information. Complete the required template sections: add Versioning checkbox completion, select appropriate SemVer level (likely PATCH for docs-only change), confirm validation steps, and document any release tags or version updates.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: polish README with factory floor screenshots' clearly and specifically describes the main change - README documentation improvements focused on adding factory floor screenshots for visual clarity.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-polish

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9da22be and f1a8ab0.

⛔ Files ignored due to path filters (2)
  • docs/images/agent-focus.png is excluded by !**/*.png
  • docs/images/factory-floor.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
nutt-adam and others added 2 commits March 21, 2026 23:44
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>
@nutt-adam
nutt-adam merged commit 93cd0a2 into main Mar 21, 2026
11 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 4, 2026
11 tasks
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.

1 participant