docs: update README with new screenshots and features#992
docs: update README with new screenshots and features#992
Conversation
- Replace old screenshots with new images from docs - Add Features section with Workspaces, AI Agents, Diff Viewer, Terminal, IDE Integration, Port Management - Add Documentation section with links to docs.superset.sh - Fix broken Discord badge URL - Add Docs badge - Add links to Claude Code, Codex, git worktrees, Cursor, VS Code, Git, GitHub CLI - Remove Cookbook section and unused reference-style links - Simplify Getting Started with clearer requirements
📝 WalkthroughWalkthroughREADME.md underwent comprehensive restructuring and content rewrite. The hero messaging shifted from "A Terminal Built for Coding Agents" to "A Desktop App for Parallel AI Coding." A Features section with Workspaces, AI Agents, Diff Viewer, Terminal, IDE Integration, and Port Management was introduced. Getting Started was reorganized into Development Setup. Documentation, Tech Stack, and Contributing sections were updated with expanded tool references and streamlined content. Legacy sections were removed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 118-120: The contributors image tag in README.md lacks an alt
attribute; update the <img> element to include meaningful alt text (e.g.,
alt="Contributors to superset-sh/superset") for accessibility and screen readers
by adding the alt attribute to the existing <img
src="https://contrib.rocks/image?repo=superset-sh/superset" /> tag.
- Around line 15-17: Replace the outdated Codex URL in the README line that
references "Codex" with the current product or docs link; locate the "Codex"
anchor in the README (the text
'[Codex](https://openai.com/index/introducing-codex/)') and update its href to
either 'https://openai.com/codex/' or
'https://platform.openai.com/docs/guides/code-generation' so the link points to
the current Codex resource.
| ## A Desktop App for Parallel AI Coding | ||
|
|
||
| Run AI coding agents like [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Codex](https://openai.com/index/introducing-codex/), and more in isolated workspaces. Each workspace is a [git worktree](https://git-scm.com/docs/git-worktree) with its own branch, terminal, and ports. Work on multiple features simultaneously without conflicts. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Claude Code documentation anthropic
💡 Result:
Anthropic’s Claude Code documentation is hosted on the official Anthropic Docs site under /docs/claude-code/. The main entry points are:
- Overview (start here): what Claude Code is and a 30-second install/start (
npm install -g@anthropic-ai/claude-code``, then runclaudein your project). [1] - Setup / Getting started: system requirements (Node.js 18+, macOS/Linux/Windows via WSL or Git Bash), install options, and authentication methods (Anthropic Console, Claude app plans, or Bedrock/Vertex). [2]
- Identity & Access Management (IAM): team auth options (Console/SSO, Bedrock, Vertex) and role-based access plus permission controls. [3]
Sources: Anthropic Docs — Claude Code Overview [1], Setup [2], IAM [3].
🌐 Web query:
OpenAI Codex documentation
💡 Result:
-
Codex overview (product page): what Codex is and how to get started (CLI install command, surfaces like IDE/terminal/cloud). [1]
https://openai.com/codex/ -
Codex CLI docs: install/run/upgrade, OS support, interactive TUI, scripting, cloud tasks, web search, approval modes, MCP, etc. [2]
https://developers.openai.com/codex/cli/ -
API “Code generation” guide (platform docs): how to use Codex in apps, and an example calling a Codex coding model via the Responses API. [3]
https://platform.openai.com/docs/guides/code-generation -
Background + rollout details (blog): “Introducing Codex” (research preview details) and GA announcement (features like Slack integration, SDK, admin tools). [4][5]
https://openai.com/index/introducing-codex/ https://openai.com/index/codex-now-generally-available/
🌐 Web query:
git worktree official documentation
💡 Result:
The official Git documentation for git worktree (manual page) is on git-scm.com:
https://git-scm.com/docs/git-worktree
It covers the command synopsis (add, list, lock, move, prune, remove, repair, unlock), behavior of “main” vs “linked” worktrees, and related configuration/details. [1]
Update Codex documentation link to current reference.
The Claude Code and git worktree links are correct. However, the Codex link points to an old blog announcement from when Codex was introduced. Update to the current product page: https://openai.com/codex/ or the API documentation at https://platform.openai.com/docs/guides/code-generation.
🤖 Prompt for AI Agents
In `@README.md` around lines 15 - 17, Replace the outdated Codex URL in the README
line that references "Codex" with the current product or docs link; locate the
"Codex" anchor in the README (the text
'[Codex](https://openai.com/index/introducing-codex/)') and update its href to
either 'https://openai.com/codex/' or
'https://platform.openai.com/docs/guides/code-generation' so the link points to
the current Codex resource.
| <a href="https://github.com/superset-sh/superset/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=superset-sh/superset" /> | ||
| </a> |
There was a problem hiding this comment.
Add alt text to contributors image for accessibility.
The contributors image is missing alt text, which is important for accessibility and screen readers.
♿ Proposed fix to add alt text
<a href="https://github.com/superset-sh/superset/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=superset-sh/superset" />
+ <img alt="Contributors" src="https://contrib.rocks/image?repo=superset-sh/superset" />
</a>📝 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.
| <a href="https://github.com/superset-sh/superset/graphs/contributors"> | |
| <img src="https://contrib.rocks/image?repo=superset-sh/superset" /> | |
| </a> | |
| <a href="https://github.com/superset-sh/superset/graphs/contributors"> | |
| <img alt="Contributors" src="https://contrib.rocks/image?repo=superset-sh/superset" /> | |
| </a> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
119-119: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In `@README.md` around lines 118 - 120, The contributors image tag in README.md
lacks an alt attribute; update the <img> element to include meaningful alt text
(e.g., alt="Contributors to superset-sh/superset") for accessibility and screen
readers by adding the alt attribute to the existing <img
src="https://contrib.rocks/image?repo=superset-sh/superset" /> tag.
🚀 Preview Deployment🔗 Preview Links
Preview updates automatically with new commits |
1 participant
Summary
Test plan
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.