Repository navigation
Conversation
Restructure the README around a ghostty-style declarative voice with a concrete headline, an About paragraph, and 5 deep-dive feature subheadings instead of the previous one-line feature table. Trim Keyboard Shortcuts and Configuration to one-line pointers to the docs site. Remove Mastra Dependencies, Private by Default, and the boilerplate Contributing checklist. Add placeholders for a real product screenshot and demo video at the top.
|
Capy auto-review is paused for this organization because the monthly auto-review limit has been reached. Increase the limit or turn it off in billing settings to resume automatic reviews. |
|
Ready to review this PR? Stage has broken it down into 4 individual chapters for you:
Chapters generated by Stage for commit 300fcb9 on May 21, 2026 6:40am UTC. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughREADME.md reorganizes top-level messaging (hero, What it is, Why, Features), reworks Supported Agents and Getting Started into a macOS-first flow with Requirements, replaces Keyboard Shortcuts with a Configuration section, shortens Contributing/Community, and expands the license paragraph. ChangesREADME Marketing and Documentation Restructure
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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: 2
🤖 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 21-25: Update the placeholder screenshot and demo link in README:
replace the TODO HTML comment and the <img> src
"apps/marketing/public/images/readme-hero.png" with the actual product-screen
image (or its new path) and ensure the alt text reflects the real UI, and
replace the anchor href "https://www.youtube.com/" (and its placeholder comment)
with the real demo video URL; remove the TODO comments so no user-visible
placeholders remain and verify the assets load correctly in the rendered README.
- Around line 44-68: The subsection headings under the "What Superset Does"
section use level-4 headings (e.g., "Parallel agents in isolated git worktrees",
"Notifications when agents need you", "Built-in diff review and inline editing",
"Reproducible workspace setup", "Universal CLI-agent compatibility") but must be
level-3 to follow the main `##` heading; change each leading "####" to "###" for
those headings in README.md so the Markdown heading hierarchy (MD001) is
satisfied.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Re-trigger cubic
Greptile SummaryThis PR rewrites the README in a declarative, docs-style voice — replacing the marketing feature table with five prose subsections, trimming the keyboard-shortcuts and configuration tables to single-line doc pointers, and removing contributor-only and boilerplate sections.
Confidence Score: 4/5Safe to merge after the two TODO placeholders are resolved — no functional code is changed. The prose restructuring is clean and anchor links resolve correctly. The two outstanding items — a duplicate hero image and a YouTube link pointing to the homepage — are present in the diff as-is and would be visible to anyone viewing the README on GitHub today. README.md — the two TODO blocks at lines 21-24 need real content before this is merged.
|
| Filename | Overview |
|---|---|
| README.md | README restructured with new prose sections, anchor table, and two unresolved TODO placeholders (duplicate hero image and placeholder YouTube URL) that the PR description requires resolving before merge. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[README.md top] --> B[Hero image - readme-hero.png]
B --> C[Badges & nav links]
C --> D[TODO placeholder - same readme-hero.png]
D --> E[TODO YouTube link - youtube.com homepage]
E --> F[About prose]
F --> G[What Superset Does - anchor table]
G --> H1[#### Parallel agents in isolated git worktrees]
G --> H2[#### Notifications when agents need you]
G --> H3[#### Built-in diff review and inline editing]
G --> H4[#### Reproducible workspace setup]
G --> H5[#### Universal CLI-agent compatibility]
H1 & H2 & H3 & H4 & H5 --> I[Supported Agents table]
I --> J[Requirements / Getting Started / Config / Shortcuts]
J --> K[Tech Stack / Contributing / Community / License]
style D fill:#ffdddd,stroke:#cc0000
style E fill:#ffdddd,stroke:#cc0000
Prompt To Fix All With AI
Fix the following 3 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 3
README.md:3
**Duplicate hero image renders twice**
The same `apps/marketing/public/images/readme-hero.png` is referenced at line 3 (the original hero) and again at line 22 (the TODO placeholder). Until the TODO at line 22 is replaced with a real product screenshot, visitors will see the same image displayed twice at the top of the README. If the intent is for line 22 to eventually hold a different screenshot, line 3 may also need to be removed to avoid duplication.
### Issue 2 of 3
README.md:24
The `href` is currently the YouTube homepage (`https://www.youtube.com/`), so clicking the link sends users to YouTube's front page instead of the demo video. The PR test plan marks this as a required fix before merging — the placeholder URL should be swapped out before landing.
```suggestion
<a href="https://www.youtube.com/YOUR_VIDEO_ID">▶ Watch the 90-second demo</a>
```
### Issue 3 of 3
README.md:44
**Heading hierarchy skips H3 (`###`)**
The feature subheadings (`####`) sit directly under the `## What Superset Does` H2, skipping the H3 level entirely. While GitHub renders this fine visually, WCAG accessibility guidelines and most Markdown linters flag a heading-level skip as a structural error that can confuse screen readers and automated outline parsers. Using `###` for these subheadings would make the document outline consistent.
Reviews (1): Last reviewed commit: "docs: modernize README" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| @@ -2,7 +2,9 @@ | |||
|
|
|||
| <img width="full" alt="Superset" src="apps/marketing/public/images/readme-hero.png" /> | |||
There was a problem hiding this comment.
The same apps/marketing/public/images/readme-hero.png is referenced at line 3 (the original hero) and again at line 22 (the TODO placeholder). Until the TODO at line 22 is replaced with a real product screenshot, visitors will see the same image displayed twice at the top of the README. If the intent is for line 22 to eventually hold a different screenshot, line 3 may also need to be removed to avoid duplication.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 3
Comment:
**Duplicate hero image renders twice**
The same `apps/marketing/public/images/readme-hero.png` is referenced at line 3 (the original hero) and again at line 22 (the TODO placeholder). Until the TODO at line 22 is replaced with a real product screenshot, visitors will see the same image displayed twice at the top of the README. If the intent is for line 22 to eventually hold a different screenshot, line 3 may also need to be removed to avoid duplication.
How can I resolve this? If you propose a fix, please make it concise.| <!-- TODO: replace with real product screenshot of the main UI with multiple workspaces --> | ||
| <img width="900" alt="Superset main UI" src="apps/marketing/public/images/readme-hero.png" /> | ||
|
|
||
| <a href="https://www.youtube.com/"><!-- TODO: replace with actual demo video URL -->▶ Watch the 90-second demo</a> |
There was a problem hiding this comment.
href is currently the YouTube homepage (https://www.youtube.com/), so clicking the link sends users to YouTube's front page instead of the demo video. The PR test plan marks this as a required fix before merging — the placeholder URL should be swapped out before landing.
| <a href="https://www.youtube.com/"><!-- TODO: replace with actual demo video URL -->▶ Watch the 90-second demo</a> | |
| <a href="https://www.youtube.com/YOUR_VIDEO_ID">▶ Watch the 90-second demo</a> |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 24
Comment:
The `href` is currently the YouTube homepage (`https://www.youtube.com/`), so clicking the link sends users to YouTube's front page instead of the demo video. The PR test plan marks this as a required fix before merging — the placeholder URL should be swapped out before landing.
```suggestion
<a href="https://www.youtube.com/YOUR_VIDEO_ID">▶ Watch the 90-second demo</a>
```
How can I resolve this? If you propose a fix, please make it concise.| | **Universal Compatibility** | Works with any CLI agent that runs in a terminal | | ||
| | **Quick Context Switching** | Jump between tasks as they need your attention | | ||
| | **IDE Integration** | Open any workspace in your favorite editor with one click | | ||
| #### Parallel agents in isolated git worktrees |
There was a problem hiding this comment.
###)
The feature subheadings (####) sit directly under the ## What Superset Does H2, skipping the H3 level entirely. While GitHub renders this fine visually, WCAG accessibility guidelines and most Markdown linters flag a heading-level skip as a structural error that can confuse screen readers and automated outline parsers. Using ### for these subheadings would make the document outline consistent.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 44
Comment:
**Heading hierarchy skips H3 (`###`)**
The feature subheadings (`####`) sit directly under the `## What Superset Does` H2, skipping the H3 level entirely. While GitHub renders this fine visually, WCAG accessibility guidelines and most Markdown linters flag a heading-level skip as a structural error that can confuse screen readers and automated outline parsers. Using `###` for these subheadings would make the document outline consistent.
How can I resolve this? If you propose a fix, please make it concise.
🧹 Preview Cleanup CompleteThe following preview resources have been cleaned up:
Thank you for your contribution! 🎉 |
- Replace broken demo link with the official Introducing Superset video - Remove TODO placeholders and duplicate hero image - Drop 'native' claim that contradicted the Electron stack - Make license framing explicit (source-available, not OSI open-source) - Add 'What runs locally' section clarifying local execution vs backend - Split Requirements: runtime deps vs build-from-source deps - Replace 'Pillar' table with plain feature headers - Add 'Why Superset' section leading with agent-agnosticism - Align headline with superset.sh (100+ agents)
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README.md (1)
33-33:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse
###for feature subsection headings under## Features.Line 33 (and the same pattern at Lines 39, 47, and 53) skips heading depth (
##→####), which violates MD001 and hurts doc structure/linting.Suggested diff
-#### Parallel agents in isolated git worktrees +### Parallel agents in isolated git worktrees -#### Works with any CLI agent +### Works with any CLI agent -#### Notifications when agents need you +### Notifications when agents need you -#### Built-in diff review and inline editing +### Built-in diff review and inline editing -#### Reproducible workspace setup +### Reproducible workspace setupAlso applies to: 39-39, 47-47, 53-53
🤖 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` at line 33, The subsection headings under "## Features" (e.g., the heading "Parallel agents in isolated git worktrees" currently using "####") should use "###" instead of "####" to preserve proper heading depth and satisfy MD001; update each affected headings (the ones at lines with texts like "Parallel agents in isolated git worktrees" and the similar headings at the other noted locations) to use "###" so they are direct subsections of "## Features" and fix the linting/doc structure issue.
🤖 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.
Duplicate comments:
In `@README.md`:
- Line 33: The subsection headings under "## Features" (e.g., the heading
"Parallel agents in isolated git worktrees" currently using "####") should use
"###" instead of "####" to preserve proper heading depth and satisfy MD001;
update each affected headings (the ones at lines with texts like "Parallel
agents in isolated git worktrees" and the similar headings at the other noted
locations) to use "###" so they are direct subsections of "## Features" and fix
the linting/doc structure issue.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
33-51:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading hierarchy to satisfy MD001.
These feature subsection headings still use h4 (
####) after an h2 (##) parent. Per Markdown best practices and the prior review comment, they should be h3 (###).Suggested fix
-#### Parallel agents in isolated git worktrees +### Parallel agents in isolated git worktrees Each task runs in its own git worktree... -#### Works with any CLI agent +### Works with any CLI agent Claude Code, Codex, Cursor Agent... -#### Notifications when agents need you +### Notifications when agents need you Superset watches every workspace... -#### Built-in diff review and inline editing +### Built-in diff review and inline editing Every workspace has a diff view... -#### Reproducible workspace setup +### Reproducible workspace setup A `.superset/config.json` at your repo root...🤖 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 33 - 51, Change the subsection headings that currently use h4 (lines starting with "#### Parallel agents in isolated git worktrees", "#### Works with any CLI agent", "#### Notifications when agents need you", "#### Built-in diff review and inline editing", and "#### Reproducible workspace setup") to h3 (use "###") so they are proper children of the surrounding h2 and satisfy MD001; update each heading token and ensure no other heading levels nearby are inadvertently altered.
🤖 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 57-64: The icon <img> elements in README.md (e.g., the <img> tags
referencing packages/ui/src/assets/icons/preset-icons/*.svg and the <img> inside
<picture> elements such as codex.svg, copilot.svg, opencode.svg, pi.svg) are
missing alt attributes; add empty alt attributes (alt="") to each decorative
<img> so screen readers ignore them (do not modify <source> tags inside
<picture>, only add alt="" to the corresponding <img> tags).
---
Duplicate comments:
In `@README.md`:
- Around line 33-51: Change the subsection headings that currently use h4 (lines
starting with "#### Parallel agents in isolated git worktrees", "#### Works with
any CLI agent", "#### Notifications when agents need you", "#### Built-in diff
review and inline editing", and "#### Reproducible workspace setup") to h3 (use
"###") so they are proper children of the surrounding h2 and satisfy MD001;
update each heading token and ensure no other heading levels nearby are
inadvertently altered.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
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`:
- Line 65: The new table row's <img> element (the inline image showing the
Mastracode icon) is missing an empty decorative alt attribute which triggers
MD045; update that <img> tag to include alt="" so screen readers ignore the
decorative icon and the Markdown linter stops flagging it, keeping the
surrounding picture/source elements 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
Summary
Cleans up the README, tightens the copy, and reorganizes it to match the layout of widely-used repos.
Changes
Content fixes
builtin-terminal-agents.tsNew sections
Structure & style
Notes