Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
2eb5c83
docs: add comprehensive documentation pages adapted from Conductor
Kitenite Jan 27, 2026
6bc8ad8
fix(docs): remove invalid image placeholder syntax that breaks MDX build
Kitenite Jan 27, 2026
4e05737
fix(docs): move CONTENT-REVIEW.md out of content directory
Kitenite Jan 27, 2026
6fd324c
fix(docs): update sidebar to include all new documentation pages
Kitenite Jan 27, 2026
b1a3399
feat(docs): add placeholder images back to documentation pages
Kitenite Jan 27, 2026
4334af9
feat(docs): add placeholder images to existing documentation pages
Kitenite Jan 27, 2026
fe47217
refactor(docs): simplify and shorten documentation
Kitenite Jan 27, 2026
7d5979d
docs: add port management, keyboard shortcuts, and customization pages
Kitenite Jan 27, 2026
39a1be8
docs: add screenshots for first workspace page
Kitenite Jan 27, 2026
cfcc9b3
docs: add branches screenshot to workspaces page
Kitenite Jan 27, 2026
24fb7f6
docs: reuse branches screenshot on parallel workspaces page
Kitenite Jan 27, 2026
a8f26b6
docs: add ports screenshot
Kitenite Jan 27, 2026
834cca6
docs: add changes screenshot to diff viewer, remove placeholder
Kitenite Jan 27, 2026
878a829
docs: add terminal screenshot, remove placeholder
Kitenite Jan 27, 2026
2c9127a
docs: add agents screenshot, remove placeholder
Kitenite Jan 27, 2026
3e7904c
docs: add YouTube video to quick-start page
Kitenite Jan 27, 2026
5a2d30d
docs: add video thumbnail to overview page
Kitenite Jan 27, 2026
a08f6e6
docs: update keyboard shortcuts with actual hotkeys from desktop app
Kitenite Jan 27, 2026
b9b013c
docs: add keyboard shortcuts settings screenshot
Kitenite Jan 27, 2026
fece6ea
docs: remove placeholder images from customization page
Kitenite Jan 27, 2026
23ab73a
docs: remove placeholder image from monorepos page
Kitenite Jan 27, 2026
b7e296e
docs: rename use-with-cursor to use-with-ide, add open-in screenshot
Kitenite Jan 27, 2026
f22d628
docs: merge workspaces-and-branches and parallel-workspaces into sing…
Kitenite Jan 27, 2026
0062627
docs: add static port configuration, remove duplicate image
Kitenite Jan 27, 2026
7ea6532
fix: update ports docs link to point to docs site instead of marketing
Kitenite Jan 27, 2026
6726cef
docs: remove placeholder image from setup scripts page
Kitenite Jan 27, 2026
aeddb14
fix: update broken links and remove stale content review doc
Kitenite Jan 27, 2026
b72c467
docs: consolidate ports content from marketing to docs site
Kitenite Jan 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { STROKE_WIDTH } from "../constants";
import { WorkspacePortGroup } from "./components/WorkspacePortGroup";
import { usePortsData } from "./hooks/usePortsData";

const PORTS_DOCS_URL = `https://${COMPANY.DOMAIN}/ports`;
const PORTS_DOCS_URL = `${COMPANY.DOCS_URL}/ports`;

export function PortsList() {
const isCollapsed = usePortsStore((s) => s.isListCollapsed);
Expand Down
32 changes: 32 additions & 0 deletions apps/docs/content/docs/agent-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: AI Agents
description: Use Claude Code and other AI agents
---

## Overview

Run AI coding agents in isolated workspaces. Each agent works independently without interfering with others.

![Agent](/images/agents.png)

## Supported Agents

- **Claude Code** - Anthropic's CLI
- **Codex** - OpenAI's assistant
- **OpenCode** - Open-source alternative

## Usage

Run agents directly in the terminal:

```bash
claude "Add error handling to fetchUser"
```

## Parallel Agents

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.
24 changes: 0 additions & 24 deletions apps/docs/content/docs/core-features.mdx

This file was deleted.

32 changes: 32 additions & 0 deletions apps/docs/content/docs/customization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Customization
description: Personalize Superset to your workflow
---

## Notification Sounds

Get audio notifications when agents finish or terminals exit.

Settings → Notifications → Choose a sound

## Project Colors

Color-code your projects in the sidebar for quick identification.

Click project settings → Choose a color

## Default Editor

Set which editor opens when you press ⌘O.

Settings → Editor → Select Cursor, VS Code, or other

## Terminal Presets

Save terminal configurations (commands, environment) as presets for quick access.

Settings → Terminal → Manage Presets

## Settings Sync

Your settings sync across devices when signed in.
23 changes: 23 additions & 0 deletions apps/docs/content/docs/diff-viewer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Diff Viewer
description: Review code changes and manage your git workflow
---

## Overview

Review changes, stage files, commit, and push—all from one interface.

![Diff Viewer](/images/changes.png)

## Features

- **View changes** - See modified, staged, and untracked files
- **Stage/unstage** - Select files for commit
- **Commit** - Write message and commit
- **Push/Pull** - Sync with remote
- **Create PR** - Open pull request on GitHub

## Diff Layouts

- **Split view** - Side by side comparison
- **Unified view** - Inline changes
Comment on lines +22 to +23
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix hyphenation for compound adjective.

Per standard grammar rules, "side by side" should be hyphenated when used as an adjective modifying a noun.

✏️ Suggested fix
-- **Split view** - Side by side comparison
+- **Split view** - Side-by-side comparison
📝 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.

Suggested change
- **Split view** - Side by side comparison
- **Unified view** - Inline changes
- **Split view** - Side-by-side comparison
- **Unified view** - Inline changes
🧰 Tools
🪛 LanguageTool

[grammar] ~23-~23: Use a hyphen to join words.
Context: ...Diff Layouts - Split view - Side by side comparison - Unified view - Inl...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@apps/docs/content/docs/diff-viewer.mdx` around lines 23 - 24, Change the
phrase "Side by side comparison" to the hyphenated form "side-by-side
comparison" in the docs content (the Markdown line that reads "**Split view** -
Side by side comparison"); update that exact text so the compound adjective is
correctly hyphenated while keeping formatting for "**Split view**" and the rest
of the list intact.

43 changes: 43 additions & 0 deletions apps/docs/content/docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: FAQ
description: Frequently asked questions
---

## General

**What platforms?**
macOS only. Windows/Linux coming soon.

**How does it work?**
Uses git worktrees to give each branch its own directory.

**Do I need an account?**
Yes, for team features and settings sync.

## Workspaces

**Same branch in multiple workspaces?**
No. One branch = one workspace. Create a new branch if needed.

**Where are workspaces stored?**
In your Superset data directory as git worktrees.

## Terminal

**Which shell?**
Your system default (bash/zsh) with your config files.

**Do sessions persist?**
Yes, terminals survive app restarts.

## Git

**Does it modify git config?**
No. Uses standard git commands.

**Private repos?**
Yes. Configure GitHub auth: `gh auth status`

## Getting Help

- Report issues: [github.com/superset-sh/superset/issues](https://github.com/superset-sh/superset/issues)
33 changes: 33 additions & 0 deletions apps/docs/content/docs/first-workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Your First Workspace
description: Create and set up your first workspace in Superset
---

## Add a Repository

Add your repo from a local folder or Git URL. Requires GitHub auth (`gh auth status`).

![Add Repository](/images/add-repo.png)

## Create a Workspace

Each workspace is an isolated git worktree on its own branch. Superset only copies git-tracked files—use [setup scripts](/setup-teardown-scripts) for `.env` files or `bun install`.

Create workspaces from:
- New branch from main
- Existing branch
- Pull request

![New Workspace](/images/new-workspace.png)

## Start Working

- **⌘O** - Open in Cursor/VS Code
- **Terminal** - Built-in terminal ready to use
- **Changes** - View diffs and commit

## Next Steps

- [Setup Scripts](/setup-teardown-scripts) - Automate `bun install`, env files
- [Workspaces](/workspaces) - Run multiple branches at once
- [IDE Integration](/use-with-ide) - Configure your editor
20 changes: 11 additions & 9 deletions apps/docs/content/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,23 @@ title: Installation
description: Install Superset on your machine
---

## Download for macOS

Get started by downloading Superset for Apple Silicon:
## Download

<DownloadButton />

## Other Platforms
## Requirements

### Windows & Linux
- **macOS** - Apple Silicon or Intel
- **Git** - Installed and configured
- **GitHub CLI** - Authenticated (`gh auth status`)

Windows and Linux support is coming soon. Join our waitlist to be notified when it's available.
## Install

### Build from Source
1. Download from button above
2. Move to Applications folder
3. Open and sign in

You can also build Superset from source on any platform:
## Build from Source

```bash
git clone https://github.com/superset-sh/superset.git
Expand All @@ -26,4 +28,4 @@ bun install
bun run build
```

See our [GitHub repository](https://github.com/superset-sh/superset) for more details.
Windows and Linux coming soon.
63 changes: 63 additions & 0 deletions apps/docs/content/docs/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Keyboard Shortcuts
description: Customize hotkeys for common actions
---

## Workspace

| Action | Shortcut |
|--------|----------|
| New Workspace | ⌘N |
| Quick Create Workspace | ⌘⇧N |
| Open Project | ⌘⇧O |
| Switch to Workspace 1-9 | ⌘1-9 |
| Previous Workspace | ⌘⌥↑ |
| Next Workspace | ⌘⌥↓ |

## Layout

| Action | Shortcut |
|--------|----------|
| Toggle Changes Tab | ⌘L |
| Toggle Expand Sidebar | ⌘⇧L |
| Toggle Workspaces Sidebar | ⌘B |
| Split Right | ⌘D |
| Split Down | ⌘⇧D |
| Split Pane Auto | ⌘E |
| Close Pane | ⌘W |

## Terminal

| Action | Shortcut |
|--------|----------|
| New Tab | ⌘T |
| Close Terminal | ⌘W |
| Clear Terminal | ⌘K |
| Find in Terminal | ⌘F |
| Scroll to Bottom | ⌘⇧↓ |
| Previous Tab | ⌘⌥← |
| Next Tab | ⌘⌥→ |
| Previous Pane | ⌘⇧← |
| Next Pane | ⌘⇧→ |
| Open Preset 1-9 | ⌘⇧1-9 |

## Window

| Action | Shortcut |
|--------|----------|
| Open in App | ⌘O |
| Copy Path | ⌘⇧C |
| Close Window | ⌘⇧W |
| Show Keyboard Shortcuts | ⌘/ |

## Customize

Open Settings → Keyboard Shortcuts to customize any hotkey.

![Keyboard Shortcuts Settings](/images/keyboard.png)

## Import/Export

Share your hotkey configuration:
- **Export** - Save your shortcuts to a file
- **Import** - Load shortcuts from a file
17 changes: 14 additions & 3 deletions apps/docs/content/docs/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,20 @@
"quick-start",
"overview",
"installation",
"first-workspace",
"---Gauge Core Features---",
"core-features",
"---BookOpen How to Guides---",
"setup-teardown-scripts"
"workspaces",
"diff-viewer",
"terminal-integration",
"ports",
"agent-integration",
"---BookOpen Guides---",
"setup-teardown-scripts",
"use-with-ide",
"using-monorepos",
"keyboard-shortcuts",
"customization",
"---CircleHelp Help---",
"faq"
]
}
55 changes: 10 additions & 45 deletions apps/docs/content/docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,55 +5,20 @@ description: Learn what Superset is and how it works

## What is Superset?

Superset is a desktop application that helps developers work more efficiently with their codebase. It combines workspace management, terminal integration, and team collaboration into a single unified experience.
Superset is a desktop app for managing multiple codebases with git worktrees. Work on several branches simultaneously, each in its own isolated workspace.

## Key Features

### Workspace Management

Organize your projects using git worktrees. Superset makes it easy to:

- Create and manage multiple worktrees for the same repository
- Switch between branches without stashing changes
- Keep your work organized across features and fixes

### Terminal Integration

Built-in terminal with powerful session management:

- Multiple terminal sessions per workspace
- Persistent sessions that survive restarts
- Quick access to common commands

### Team Collaboration
![Superset Overview](/images/video-thumbnail.png)

Work together with your team seamlessly:
## Key Features

- Share workspaces with team members
- Sync configurations across devices
- Manage team permissions and access
- **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.

## How It Works

Superset sits on top of your existing git workflow and enhances it with a visual interface and productivity tools. It doesn't replace git—it makes it easier to use.

### Git Worktrees

Instead of switching branches in a single directory, Superset uses git worktrees to give each branch its own directory. This means:

- No more stashing uncommitted changes
- Run multiple branches simultaneously
- Keep your IDE state intact when switching contexts

### Local-First Architecture

Your data stays on your machine. Superset works offline and syncs when you're connected.

## Tech Stack

Superset is built with modern technologies:
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.

- **Electron** - Cross-platform desktop framework
- **React** - UI components with TypeScript
- **SQLite** - Local database for fast queries
- **Git** - Version control integration
Your data stays local. Superset works offline and syncs when connected.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# First, let's look at the file and its context
cat -n apps/docs/content/docs/overview.mdx | head -40

Repository: superset-sh/superset

Length of output: 1218


🏁 Script executed:

# Search for telemetry, analytics, and tracking code
rg -i "telemetry|analytics|tracking|beacon" --type ts --type tsx --type js --type jsx -A 3 | head -100

Repository: superset-sh/superset

Length of output: 91


🏁 Script executed:

# Search for sync-related code
rg -i "sync.*when.*connected|auto.*sync|background.*sync" -A 2 | head -80

Repository: superset-sh/superset

Length of output: 50378


🏁 Script executed:

# Look for offline-related code and configuration
rg -i "offline|persist|local.*storage|service.*worker" --type ts --type tsx --type js --type jsx | head -100

Repository: superset-sh/superset

Length of output: 91


🏁 Script executed:

# Check if there's any documentation about data privacy or sync behavior
fd -e md -e mdx | xargs rg -l "offline|privacy|data stays|sync.*connected" | head -20

Repository: superset-sh/superset

Length of output: 200


🏁 Script executed:

# Search for sync and network-related code in specific file types
rg "sync|offline" apps/desktop --type js --type ts -l | head -20

Repository: superset-sh/superset

Length of output: 1822


🏁 Script executed:

# Look for API calls and network communication
rg "fetch|http|axios|request|api" apps/desktop -l --type js --type ts | head -15

Repository: superset-sh/superset

Length of output: 898


🏁 Script executed:

# Check for any telemetry or data transmission code
rg "telemetry|analytics|track|send|post.*data" apps/desktop -l --type js --type ts

Repository: superset-sh/superset

Length of output: 6459


🏁 Script executed:

# Look for README or architecture documentation
fd -e md -e txt "README|ARCHITECTURE|DESIGN" apps/desktop

Repository: superset-sh/superset

Length of output: 106


🏁 Script executed:

# Check the analytics implementation
cat -n apps/desktop/src/lib/trpc/routers/analytics/index.ts | head -100

Repository: superset-sh/superset

Length of output: 584


🏁 Script executed:

# Check PostHog integration
rg "posthog|PostHog" apps/desktop/src -A 3 -B 1 | head -150

Repository: superset-sh/superset

Length of output: 13592


🏁 Script executed:

# Look for any data sync mechanism
rg "sync" apps/desktop/src/lib -A 2 -B 1 | head -100

Repository: superset-sh/superset

Length of output: 7020


🏁 Script executed:

# Check if there's documentation about data privacy or sync
cat apps/desktop/README.md 2>/dev/null || echo "No README"

Repository: superset-sh/superset

Length of output: 73


🏁 Script executed:

# Look for environment configuration that might control telemetry
fd -e env -e config "apps/desktop" -type f | head -10

Repository: superset-sh/superset

Length of output: 234


Qualify the "data stays local" claim to clarify telemetry behavior.

Line 25 states "Your data stays local" but the app includes PostHog analytics that sends telemetry to external servers. While git repositories and workspace code remain local, user interaction data is transmitted. Either clarify that the statement refers only to code/repository data, or add language about telemetry collection. This prevents privacy/compliance misunderstandings.

Example revision:

  • Current: "Your data stays local. Superset works offline and syncs when connected."
  • Revised: "Your code stays local. Superset works offline, syncing git changes when connected. Analytics data is sent to improve your experience."
🤖 Prompt for AI Agents
In `@apps/docs/content/docs/overview.mdx` at line 25, Update the sentence "Your
data stays local. Superset works offline and syncs when connected." in the
overview content to qualify what "data" means and mention telemetry: replace or
reword the string "Your data stays local." (and the following sync sentence) to
explicitly state that code/repositories remain local and that
analytics/telemetry (PostHog) may be sent to external servers; e.g., change to
something like "Your code stays local. Superset works offline, syncing git
changes when connected. Analytics data is sent to improve your experience."
Ensure the edited text appears where the original sentence string is defined in
the overview content.

Loading