Skip to content

Commit d63a5cb

Browse files
waleedlatif1waleedlatif1
authored
v0.5.71: ux, ci improvements, docs updates
2 parents 8bd5d41 + 1bf5ed4 commit d63a5cb

File tree

21 files changed

+1031
-315
lines changed

21 files changed

+1031
-315
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ jobs:
2727
steps:
2828
- name: Extract version from commit message
2929
id: extract
30+
env:
31+
COMMIT_MSG: ${{ github.event.head_commit.message }}
3032
run: |
31-
COMMIT_MSG="${{ github.event.head_commit.message }}"
3233
# Only tag versions on main branch
33-
if [ "${{ github.ref }}" = "refs/heads/main" ] && [[ "$COMMIT_MSG" =~ ^(v[0-9]+\.[0-9]+\.[0-9]+): ]]; then
34+
if [ "$GITHUB_REF" = "refs/heads/main" ] && [[ "$COMMIT_MSG" =~ ^(v[0-9]+\.[0-9]+\.[0-9]+): ]]; then
3435
VERSION="${BASH_REMATCH[1]}"
3536
echo "version=${VERSION}" >> $GITHUB_OUTPUT
3637
echo "is_release=true" >> $GITHUB_OUTPUT

‎apps/docs/app/global.css‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,19 @@ aside#nd-sidebar {
119119
}
120120
}
121121

122+
/* Hide TOC popover on tablet/medium screens (768px - 1279px) */
123+
/* Keeps it visible on mobile (<768px) for easy navigation */
124+
/* Desktop (>=1280px) already hides it via fumadocs xl:hidden */
125+
@media (min-width: 768px) and (max-width: 1279px) {
126+
#nd-docs-layout {
127+
--fd-toc-popover-height: 0px !important;
128+
}
129+
130+
[data-toc-popover] {
131+
display: none !important;
132+
}
133+
}
134+
122135
/* Desktop only: Apply custom navbar offset, sidebar width and margin offsets */
123136
/* On mobile, let fumadocs handle the layout natively */
124137
@media (min-width: 1024px) {

‎apps/docs/content/docs/en/copilot/index.mdx‎

Lines changed: 133 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,25 @@ title: Copilot
55
import { Callout } from 'fumadocs-ui/components/callout'
66
import { Card, Cards } from 'fumadocs-ui/components/card'
77
import { Image } from '@/components/ui/image'
8-
import { MessageCircle, Package, Zap, Infinity as InfinityIcon, Brain, BrainCircuit } from 'lucide-react'
8+
import { MessageCircle, Hammer, Zap, Globe, Paperclip, History, RotateCcw, Brain } from 'lucide-react'
99

10-
Copilot is your in-editor assistant that helps you build and edit workflows with Sim Copilot, as well as understand and improve them. It can:
10+
Copilot is your in-editor assistant that helps you build and edit workflows. It can:
1111

1212
- **Explain**: Answer questions about Sim and your current workflow
1313
- **Guide**: Suggest edits and best practices
14-
- **Edit**: Make changes to blocks, connections, and settings when you approve
14+
- **Build**: Add blocks, wire connections, and configure settings
15+
- **Debug**: Analyze execution issues and optimize performance
1516

1617
<Callout type="info">
17-
Copilot is a Sim-managed service. For self-hosted deployments, generate a Copilot API key in the hosted app (sim.ai → Settings → Copilot)
18+
Copilot is a Sim-managed service. For self-hosted deployments:
1819
1. Go to [sim.ai](https://sim.ai) → Settings → Copilot and generate a Copilot API key
19-
2. Set `COPILOT_API_KEY` in your self-hosted environment to that value
20+
2. Set `COPILOT_API_KEY` in your self-hosted environment
2021
</Callout>
2122

22-
## Context Menu (@)
23-
24-
Use the `@` symbol to reference various resources and give Copilot more context about your workspace:
25-
26-
<Image
27-
src="/static/copilot/copilot-menu.png"
28-
alt="Copilot context menu showing available reference options"
29-
width={600}
30-
height={400}
31-
/>
32-
33-
The `@` menu provides access to:
34-
- **Chats**: Reference previous copilot conversations
35-
- **All workflows**: Reference any workflow in your workspace
36-
- **Workflow Blocks**: Reference specific blocks from workflows
37-
- **Blocks**: Reference block types and templates
38-
- **Knowledge**: Reference your uploaded documents and knowledgebase
39-
- **Docs**: Reference Sim documentation
40-
- **Templates**: Reference workflow templates
41-
- **Logs**: Reference execution logs and results
42-
43-
This contextual information helps Copilot provide more accurate and relevant assistance for your specific use case.
44-
4523
## Modes
4624

25+
Switch between modes using the mode selector at the bottom of the input area.
26+
4727
<Cards>
4828
<Card
4929
title={
@@ -60,113 +40,153 @@ This contextual information helps Copilot provide more accurate and relevant ass
6040
<Card
6141
title={
6242
<span className="inline-flex items-center gap-2">
63-
<Package className="h-4 w-4 text-muted-foreground" />
64-
Agent
43+
<Hammer className="h-4 w-4 text-muted-foreground" />
44+
Build
6545
</span>
6646
}
6747
>
6848
<div className="m-0 text-sm">
69-
Build-and-edit mode. Copilot proposes specific edits (add blocks, wire variables, tweak settings) and applies them when you approve.
49+
Workflow building mode. Copilot can add blocks, wire connections, edit configurations, and debug issues.
7050
</div>
7151
</Card>
7252
</Cards>
7353

74-
<div className="flex justify-center">
75-
<Image
76-
src="/static/copilot/copilot-mode.png"
77-
alt="Copilot mode selection interface"
78-
width={600}
79-
height={400}
80-
className="my-6"
81-
/>
82-
</div>
54+
## Models
8355

84-
## Depth Levels
56+
Select your preferred AI model using the model selector at the bottom right of the input area.
8557

86-
<Cards>
87-
<Card
88-
title={
89-
<span className="inline-flex items-center gap-2">
90-
<Zap className="h-4 w-4 text-muted-foreground" />
91-
Fast
92-
</span>
93-
}
94-
>
95-
<div className="m-0 text-sm">Quickest and cheapest. Best for small edits, simple workflows, and minor tweaks.</div>
96-
</Card>
97-
<Card
98-
title={
99-
<span className="inline-flex items-center gap-2">
100-
<InfinityIcon className="h-4 w-4 text-muted-foreground" />
101-
Auto
102-
</span>
103-
}
104-
>
105-
<div className="m-0 text-sm">Balanced speed and reasoning. Recommended default for most tasks.</div>
106-
</Card>
107-
<Card
108-
title={
109-
<span className="inline-flex items-center gap-2">
110-
<Brain className="h-4 w-4 text-muted-foreground" />
111-
Advanced
112-
</span>
113-
}
114-
>
115-
<div className="m-0 text-sm">More reasoning for larger workflows and complex edits while staying performant.</div>
116-
</Card>
117-
<Card
118-
title={
119-
<span className="inline-flex items-center gap-2">
120-
<BrainCircuit className="h-4 w-4 text-muted-foreground" />
121-
Behemoth
122-
</span>
123-
}
124-
>
125-
<div className="m-0 text-sm">Maximum reasoning for deep planning, debugging, and complex architectural changes.</div>
126-
</Card>
127-
</Cards>
58+
**Available Models:**
59+
- Claude 4.5 Opus, Sonnet (default), Haiku
60+
- GPT 5.2 Codex, Pro
61+
- Gemini 3 Pro
12862

129-
### Mode Selection Interface
63+
Choose based on your needs: faster models for simple tasks, more capable models for complex workflows.
13064

131-
You can easily switch between different reasoning modes using the mode selector in the Copilot interface:
65+
## Context Menu (@)
13266

133-
<Image
134-
src="/static/copilot/copilot-models.png"
135-
alt="Copilot mode selection showing Advanced mode with MAX toggle"
136-
width={600}
137-
height={300}
138-
/>
67+
Use the `@` symbol to reference resources and give Copilot more context:
13968

140-
The interface allows you to:
141-
- **Select reasoning level**: Choose from Fast, Auto, Advanced, or Behemoth
142-
- **Enable MAX mode**: Toggle for maximum reasoning capabilities when you need the most thorough analysis
143-
- **See mode descriptions**: Understand what each mode is optimized for
69+
| Reference | Description |
70+
|-----------|-------------|
71+
| **Chats** | Previous copilot conversations |
72+
| **Workflows** | Any workflow in your workspace |
73+
| **Workflow Blocks** | Blocks in the current workflow |
74+
| **Blocks** | Block types and templates |
75+
| **Knowledge** | Uploaded documents and knowledge bases |
76+
| **Docs** | Sim documentation |
77+
| **Templates** | Workflow templates |
78+
| **Logs** | Execution logs and results |
14479

145-
Choose your mode based on the complexity of your task - use Fast for simple questions and Behemoth for complex architectural changes.
80+
Type `@` in the input field to open the context menu, then search or browse to find what you need.
14681

147-
## Billing and Cost Calculation
82+
## Slash Commands (/)
14883

149-
### How Costs Are Calculated
84+
Use slash commands for quick actions:
15085

151-
Copilot usage is billed per token from the underlying LLM:
86+
| Command | Description |
87+
|---------|-------------|
88+
| `/fast` | Fast mode execution |
89+
| `/research` | Research and exploration mode |
90+
| `/actions` | Execute agent actions |
15291

153-
- **Input tokens**: billed at the provider's base rate (**at-cost**)
154-
- **Output tokens**: billed at **1.5×** the provider's base output rate
92+
**Web Commands:**
15593

156-
```javascript
157-
copilotCost = (inputTokens × inputPrice + outputTokens × (outputPrice × 1.5)) / 1,000,000
158-
```
94+
| Command | Description |
95+
|---------|-------------|
96+
| `/search` | Search the web |
97+
| `/read` | Read a specific URL |
98+
| `/scrape` | Scrape web page content |
99+
| `/crawl` | Crawl multiple pages |
159100

160-
| Component | Rate Applied |
161-
|----------|----------------------|
162-
| Input | inputPrice |
163-
| Output | outputPrice × 1.5 |
101+
Type `/` in the input field to see available commands.
164102

165-
<Callout type="warning">
166-
Pricing shown reflects rates as of September 4, 2025. Check provider documentation for current pricing.
167-
</Callout>
103+
## Chat Management
104+
105+
### Starting a New Chat
106+
107+
Click the **+** button in the Copilot header to start a fresh conversation.
108+
109+
### Chat History
110+
111+
Click **History** to view previous conversations grouped by date. You can:
112+
- Click a chat to resume it
113+
- Delete chats you no longer need
114+
115+
### Editing Messages
116+
117+
Hover over any of your messages and click **Edit** to modify and resend it. This is useful for refining your prompts.
118+
119+
### Message Queue
120+
121+
If you send a message while Copilot is still responding, it gets queued. You can:
122+
- View queued messages in the expandable queue panel
123+
- Send a queued message immediately (aborts current response)
124+
- Remove messages from the queue
125+
126+
## File Attachments
127+
128+
Click the attachment icon to upload files with your message. Supported file types include:
129+
- Images (preview thumbnails shown)
130+
- PDFs
131+
- Text files, JSON, XML
132+
- Other document formats
133+
134+
Files are displayed as clickable thumbnails that open in a new tab.
135+
136+
## Checkpoints & Changes
137+
138+
When Copilot makes changes to your workflow, it saves checkpoints so you can revert if needed.
139+
140+
### Viewing Checkpoints
141+
142+
Hover over a Copilot message and click the checkpoints icon to see saved workflow states for that message.
143+
144+
### Reverting Changes
145+
146+
Click **Revert** on any checkpoint to restore your workflow to that state. A confirmation dialog will warn that this action cannot be undone.
147+
148+
### Accepting Changes
149+
150+
When Copilot proposes changes, you can:
151+
- **Accept**: Apply the proposed changes (`Mod+Shift+Enter`)
152+
- **Reject**: Dismiss the changes and keep your current workflow
153+
154+
## Thinking Blocks
155+
156+
For complex requests, Copilot may show its reasoning process in expandable thinking blocks:
157+
158+
- Blocks auto-expand while Copilot is thinking
159+
- Click to manually expand/collapse
160+
- Shows duration of the thinking process
161+
- Helps you understand how Copilot arrived at its solution
162+
163+
## Options Selection
164+
165+
When Copilot presents multiple options, you can select using:
166+
167+
| Control | Action |
168+
|---------|--------|
169+
| **1-9** | Select option by number |
170+
| **Arrow Up/Down** | Navigate between options |
171+
| **Enter** | Select highlighted option |
172+
173+
Selected options are highlighted; unselected options appear struck through.
174+
175+
## Keyboard Shortcuts
176+
177+
| Shortcut | Action |
178+
|----------|--------|
179+
| `@` | Open context menu |
180+
| `/` | Open slash commands |
181+
| `Arrow Up/Down` | Navigate menu items |
182+
| `Enter` | Select menu item |
183+
| `Esc` | Close menus |
184+
| `Mod+Shift+Enter` | Accept Copilot changes |
185+
186+
## Usage Limits
187+
188+
Copilot usage is billed per token from the underlying LLM. If you reach your usage limit, Copilot will prompt you to increase your limit. You can add usage in increments ($50, $100) from your current base.
168189

169190
<Callout type="info">
170-
Model prices are per million tokens. The calculation divides by 1,000,000 to get the actual cost. See <a href="/execution/costs">the Cost Calculation page</a> for background and examples.
191+
See the [Cost Calculation page](/execution/costs) for billing details.
171192
</Callout>
172-

‎apps/docs/content/docs/en/keyboard-shortcuts/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Speed up your workflow building with these keyboard shortcuts and mouse controls
3434
| `Mod` + `V` | Paste blocks |
3535
| `Delete` or `Backspace` | Delete selected blocks or edges |
3636
| `Shift` + `L` | Auto-layout canvas |
37+
| `Mod` + `Shift` + `F` | Fit to view |
38+
| `Mod` + `Shift` + `Enter` | Accept Copilot changes |
3739

3840
## Panel Navigation
3941

‎apps/docs/content/docs/en/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"pages": [
44
"./introduction/index",
55
"./getting-started/index",
6+
"./quick-reference/index",
67
"triggers",
78
"blocks",
89
"tools",

0 commit comments

Comments
 (0)