diff --git a/apps/docs/content/docs/agent-integration.mdx b/apps/docs/content/docs/agent-integration.mdx index 18a7497502a..fa13177e97b 100644 --- a/apps/docs/content/docs/agent-integration.mdx +++ b/apps/docs/content/docs/agent-integration.mdx @@ -25,14 +25,8 @@ claude "Add error handling to fetchUser" ## Parallel Agents -Create multiple workspaces and run an agent in each. Compare results and merge the best solution. See [Parallel Agents](/parallel-agents) for a detailed guide. +Create multiple workspaces and run an agent in each. Compare results and merge the best solution. ## Notifications -Get notified when agents finish. Configure sounds in Settings → Notifications. - -## Next Steps - -- [Parallel Agents](/parallel-agents) — Run multiple agents at the same time -- [Terminal Presets](/terminal-presets) — Auto-launch agents on workspace creation -- [MCP Server](/mcp) — Let agents control Superset programmatically +Get notified when agents finish. Configure sounds in Settings. diff --git a/apps/docs/content/docs/meta.json b/apps/docs/content/docs/meta.json index 439bef23ea5..d8e8b14a6d8 100644 --- a/apps/docs/content/docs/meta.json +++ b/apps/docs/content/docs/meta.json @@ -2,27 +2,23 @@ "title": "Documentation", "pages": [ "---Rocket Get Started---", - "overview", "installation", + "overview", "first-workspace", - "workflow", "---Gauge Core Features---", - "parallel-agents", "workspaces", - "task-management", "diff-viewer", "terminal-integration", "ports", + "agent-integration", "mcp", "---BookOpen Guides---", - "agent-integration", "setup-teardown-scripts", "use-with-ide", - "terminal-presets", - "customization", - "---Lightbulb Tips---", "using-monorepos", + "terminal-presets", "keyboard-shortcuts", + "customization", "---CircleHelp Help---", "faq" ] diff --git a/apps/docs/content/docs/overview.mdx b/apps/docs/content/docs/overview.mdx index 2c84c52d0c3..f8da282c654 100644 --- a/apps/docs/content/docs/overview.mdx +++ b/apps/docs/content/docs/overview.mdx @@ -1,87 +1,22 @@ --- -title: Welcome -description: Superset is a desktop app for running multiple AI coding agents in parallel +title: Overview +description: Learn what Superset is and how it works --- ## What is Superset? -Superset is a macOS desktop app for running multiple AI coding agents simultaneously. Each agent works in its own isolated workspace (a git worktree), so you can hand off parallel tasks and review results as they come in. +Superset is a desktop app for managing multiple codebases with git worktrees. Work on several branches simultaneously, each in its own isolated workspace. -**Wait less, ship more.** +## Key Features - +- **Workspaces** - Each branch gets its own directory via git worktrees. No more stashing. +- **Terminal** - Built-in terminal with persistent sessions per workspace. +- **Diff Viewer** - Review changes, stage files, commit, and push. +- **AI Agents** - Run Claude Code or other agents in isolated workspaces. +- **IDE Integration** - Open any workspace in Cursor or VS Code. -## Get Started +## How It Works - +Superset uses [git worktrees](https://git-scm.com/docs/git-worktree) to give each branch its own directory. Switch contexts instantly without losing your place. -## Core Features - - - -## Guides - - +Your data stays local. Superset works offline and syncs when connected. diff --git a/apps/docs/content/docs/parallel-agents.mdx b/apps/docs/content/docs/parallel-agents.mdx deleted file mode 100644 index 717c368c98e..00000000000 --- a/apps/docs/content/docs/parallel-agents.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Parallel Agents -description: Run multiple AI coding agents simultaneously in isolated workspaces ---- - -## Overview - -Run multiple AI agents at the same time, each in its own isolated workspace. This is the core value of Superset — instead of waiting for one agent to finish before starting the next, run them all in parallel. - -## How It Works - -Each workspace is a separate git worktree with its own branch and directory. Agents can't interfere with each other because they're working on different files in different directories. - -1. Create workspace A → launch Claude on task A -2. Create workspace B → launch Claude on task B -3. Create workspace C → launch Claude on task C -4. Monitor all three from the sidebar -5. Review and merge as each finishes - -## Supported Agents - -| Agent | Command | -|-------|---------| -| **Claude Code** | `claude` | -| **Codex** | `codex` | -| **Gemini CLI** | `gemini` | -| **OpenCode** | `opencode` | -| **Any CLI agent** | Works in the terminal | - -## Monitoring - -The workspace sidebar shows live status for every workspace: - -- **Spinning** — agent is actively working -- **Amber** — agent needs input or hit an error -- **Green** — work is done, ready for review - -Audio notifications alert you when agents finish. Configure sounds in Settings → Notifications. - -## Auto-Launch with Presets - -Set up a [terminal preset](/terminal-presets) for your preferred agent and mark it as default. New workspaces will automatically launch the agent when created. - -Quick-add templates are available for Claude, Codex, Gemini, Cursor Agent, and OpenCode. - -## Subagents - -Use the [MCP server](/mcp) `start_claude_session` tool to spawn subagents within an existing workspace. Pass a `paneId` to add a new terminal pane to an existing tab — useful for breaking a large task into parallel subtasks. - -## Tips - -- Start with 2-3 agents and scale up as you get comfortable -- Use descriptive branch names so you can tell workspaces apart at a glance -- Set up [setup scripts](/setup-teardown-scripts) to automate `bun install` and env file copying — each workspace needs its own dependencies -- Delete workspaces after merging to keep things clean - -## Next Steps - -- [Terminal Presets](/terminal-presets) — Auto-launch agents on workspace creation -- [Task Management](/task-management) — Manage what each agent works on -- [Workflow](/workflow) — The full development loop diff --git a/apps/docs/content/docs/task-management.mdx b/apps/docs/content/docs/task-management.mdx deleted file mode 100644 index 8effeba2221..00000000000 --- a/apps/docs/content/docs/task-management.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Task Management -description: Organize, track, and execute tasks from a single interface ---- - -## Overview - -Superset has a built-in task tracker. Create tasks, assign them, set priorities, and launch agents — all without leaving the app. - -## Creating Tasks - -Create tasks from the Tasks view or via the [MCP server](/mcp). Each task has: - -| Field | Description | -|-------|-------------| -| **Title** | Short description of the work | -| **Description** | Detailed context, requirements, or instructions | -| **Status** | Backlog, Todo, In Progress, Done, Cancelled | -| **Priority** | Urgent, High, Medium, Low, None | -| **Labels** | Tags for categorization | -| **Assignee** | Team member responsible | - -## Start Working - -The "Start Working" button on any task: - -1. Creates a new workspace (git worktree + branch) -2. Feeds the task title and description to Claude as context -3. Launches Claude Code in the workspace terminal - -The agent starts working immediately with full context about what needs to be done. - -## Batch Mode - -Select multiple tasks and click "Start Working" to create workspaces for all of them at once. Each gets its own isolated workspace with its own Claude session. - -## MCP Integration - -AI agents can manage tasks programmatically via the [MCP server](/mcp): - -``` -"Create a task for fixing the login validation bug" -"List all my high-priority tasks" -"Update the auth task status to done" -``` - -Available MCP tools: `create_task`, `update_task`, `list_tasks`, `get_task`, `delete_task`, `list_task_statuses`. - -## Next Steps - -- [Workflow](/workflow) — See how tasks fit into the development loop -- [MCP Server](/mcp) — Automate task management with AI agents -- [Parallel Agents](/parallel-agents) — Run multiple tasks simultaneously diff --git a/apps/docs/content/docs/workflow.mdx b/apps/docs/content/docs/workflow.mdx deleted file mode 100644 index 688643dfa96..00000000000 --- a/apps/docs/content/docs/workflow.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Workflow -description: The end-to-end development workflow in Superset ---- - -## The Loop - -Superset is built around a simple loop: **create a workspace, do the work, review, merge, delete**. - -1. **Pick a task** — from your task board, a GitHub issue, or your head -2. **Create a workspace** — `⌘N` spins up an isolated git worktree on a new branch -3. **Work** — code manually, run an AI agent, or both -4. **Review** — check the diff viewer, run tests, iterate -5. **Ship** — commit, push, and create a PR from the sidebar -6. **Clean up** — delete the workspace after merge - -The power comes from running steps 1–6 for multiple tasks **at the same time**. - -## Creating Workspaces - -Every workspace is a git worktree — a real directory with its own branch, terminal sessions, and port range. No stashing, no context switching. - -Create from: -- **New branch** — start fresh from main -- **Existing branch** — pick up where you left off -- **Pull request** — review or continue someone else's work -- **Task** — click "Start Working" on any task to auto-create a workspace with context - -## Running Agents - -Once a workspace is ready, launch an AI agent in the terminal: - -```bash -claude "Implement the auth middleware" -``` - -Or use [terminal presets](/terminal-presets) to auto-launch agents when workspaces are created. - -While one agent works, create another workspace and start a second task. Superset's sidebar shows live status for every workspace — spinning means working, amber means needs attention, green means ready to review. - -See [Parallel Agents](/parallel-agents) for more. - -## Reviewing Changes - -The right sidebar shows all changes in the workspace: - -- **Stage/unstage files** — select exactly what to commit -- **View diffs** — split or unified, with [focus mode](/diff-viewer) for one file at a time -- **Commit and push** — write a message and push in one step -- **Create a PR** — open a pull request directly from Superset - -## From Task to PR - -The fastest path from idea to pull request: - -1. Open the Tasks view and find your task -2. Click **Start Working** — Superset creates a workspace and launches Claude with your task description as context -3. Monitor progress in the sidebar -4. When Claude finishes, review the diff and create a PR -5. Delete the workspace - -Repeat for every task in your backlog. Run as many in parallel as your machine can handle. - -## Next Steps - -- [Parallel Agents](/parallel-agents) — Run multiple agents simultaneously -- [Task Management](/task-management) — Organize and track your work -- [Setup Scripts](/setup-teardown-scripts) — Automate workspace initialization diff --git a/apps/docs/next.config.mjs b/apps/docs/next.config.mjs index c656a361dd4..2b0fcb13ec8 100644 --- a/apps/docs/next.config.mjs +++ b/apps/docs/next.config.mjs @@ -29,12 +29,12 @@ const config = { return [ { source: "/", - destination: "/overview", + destination: "/installation", permanent: false, }, { source: "/docs", - destination: "/overview", + destination: "/installation", permanent: false, }, ]; diff --git a/apps/docs/src/components/ResourceCard/ResourceCard.tsx b/apps/docs/src/components/ResourceCard/ResourceCard.tsx index e260a4c4268..91b9a01579e 100644 --- a/apps/docs/src/components/ResourceCard/ResourceCard.tsx +++ b/apps/docs/src/components/ResourceCard/ResourceCard.tsx @@ -16,7 +16,6 @@ export function ResourceCard({ tags, className, }: ResourceCardProps) { - const isExternal = href.startsWith("http"); return (