-
Notifications
You must be signed in to change notification settings - Fork 935
docs: add comprehensive documentation pages #981
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
2eb5c83
6bc8ad8
4e05737
6fd324c
b1a3399
4334af9
fe47217
7d5979d
39a1be8
cfcc9b3
24fb7f6
a8f26b6
834cca6
878a829
2c9127a
3e7904c
5a2d30d
a08f6e6
b9b013c
fece6ea
23ab73a
b7e296e
f22d628
0062627
7ea6532
6726cef
aeddb14
b72c467
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## 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. |
This file was deleted.
| 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. |
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## 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 | ||
| 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) |
| 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`). | ||
|
|
||
|  | ||
|
|
||
| ## 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 | ||
|
|
||
|  | ||
|
|
||
| ## 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 |
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## Import/Export | ||
|
|
||
| Share your hotkey configuration: | ||
| - **Export** - Save your shortcuts to a file | ||
| - **Import** - Load shortcuts from a file |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|  | ||
|
|
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: # First, let's look at the file and its context
cat -n apps/docs/content/docs/overview.mdx | head -40Repository: 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 -100Repository: 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 -80Repository: 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 -100Repository: 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 -20Repository: 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 -20Repository: 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 -15Repository: 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 tsRepository: superset-sh/superset Length of output: 6459 🏁 Script executed: # Look for README or architecture documentation
fd -e md -e txt "README|ARCHITECTURE|DESIGN" apps/desktopRepository: 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 -100Repository: superset-sh/superset Length of output: 584 🏁 Script executed: # Check PostHog integration
rg "posthog|PostHog" apps/desktop/src -A 3 -B 1 | head -150Repository: 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 -100Repository: 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 -10Repository: 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:
🤖 Prompt for AI Agents |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
📝 Committable suggestion
🧰 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