Skip to content

Commit f01bdcf

Browse files
committed
Update online editor docs with images and UI walkthroughs
Significantly expanded Online.md with new screenshots and step-by-step UI guides for creating jobs, using the code tab, and interacting with the AI Code Assistant. Replaced the Mermaid flowchart with illustrated, image-based documentation. Added several PNG images to support the updated docs, including create-online-job.png and editor-full-editor.png. Clarified deployment instructions in Deployment.md and improved formatting and clarity throughout. The AI Code Assistant section now features a screenshot and recommends Claude Opus 4.6+ for best results. These changes make the documentation more visual, user-friendly, and accessible for new users.
1 parent 967aa2d commit f01bdcf

File tree

8 files changed

+27
-36
lines changed

8 files changed

+27
-36
lines changed

wiki-content/Deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The repository includes an `azure.yaml` file in the AppHost project, enabling de
6464

6565
The fastest way to deploy is a single command that combines provisioning and deployment.
6666

67-
Navigate to the AppHost root directory and run:
67+
In the Command prompt window, or the Terminal window in `Visual Studio` or `Visual Studio Code`, navigate to the `AppHost` directory and run:
6868

6969
```bash
7070
azd auth login
@@ -80,7 +80,7 @@ This command:
8080
2. Builds and containerizes all services (Web, Scheduler, Agent)
8181
3. Deploys everything to Azure Container Apps
8282

83-
No manual infrastructure setup is required. The Aspire AppHost defines the entire application topology, and `azd` translates it into Azure resources automatically.
83+
No manual infrastructure setup is required. The **Aspire AppHost** defines the entire application topology, and `azd` translates it into Azure resources automatically.
8484

8585
### Step-by-Step Deployment
8686

wiki-content/Online.md

Lines changed: 25 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,42 @@ The online code editor allows you to write, compile, and deploy jobs directly in
66

77
## Overview
88

9-
The editor is embedded in the **Code Tab** of the Job Details dialog. It uses the [Monaco Editor](https://microsoft.github.io/monaco-editor/) (the same editor that powers Visual Studio Code) and supports both C# and Python. Combined with the AI Code Assistant, it provides a complete development environment for automation jobs without any local setup.
9+
![create-online-job.png](images/create-online-job.png)
1010

11-
---
11+
The editor is embedded in the **Code Tab** of the Job Details dialog. It uses the [Monaco Editor](https://microsoft.github.io/monaco-editor/) (the same editor that powers Visual Studio Code) and supports both `C#` and `Python`. Combined with the AI Code Assistant, it provides a complete development environment for automation jobs without any local setup.
1212

13-
## Code Tab User Flow
14-
15-
```mermaid
16-
flowchart TD
17-
%% Styling
18-
classDef action fill:#0078d4,stroke:#005a9e,stroke-width:2px,color:#fff,rx:5,ry:5;
19-
classDef decision fill:#fff,stroke:#0078d4,stroke-width:2px,rx:5,ry:5;
20-
classDef state fill:#eef6ff,stroke:#0078d4,stroke-width:2px,rx:5,ry:5;
21-
22-
A[🚀 Open Job Details]:::action --> B[Navigate to Code Tab]:::action
23-
B --> C{Select Mode}:::decision
24-
C -->|Code Edit| D[📝 Monaco Editor]:::state
25-
C -->|Code Upload| E[📂 Upload .nupkg]:::action
26-
D --> F[Select File from Dropdown]:::action
27-
F --> G[✍️ Edit Code]:::state
28-
G --> H[💾 Save & Compile]:::action
29-
H --> I{Compilation Result}:::decision
30-
I -->|Success| J[📦 NuGet Package Created]:::state
31-
I -->|Error| K[⚠️ Error Dialog]:::state
32-
K --> G
33-
J --> L[☁️ Upload to Blob Storage]:::state
34-
E --> L
35-
L --> M[✅ Job Ready to Execute]:::state
36-
D --> N[▶️ Run Job Now]:::action
37-
N --> H
38-
```
3913

4014
---
4115

16+
## Create A New Job
17+
18+
![create-online-job.png](images/create-new-job-button.png)
19+
20+
To create a new job click the `Create New Job` button.
21+
22+
![create-new-job-dialog.png](images/create-new-job-dialog.png)
23+
24+
Give the job a name and click the `Save` button.
25+
4226
## UI Modes
4327

44-
The Code Tab has two modes, selectable via a dropdown:
28+
![create-new-job-dialog.png](images/code-tab.png)
29+
30+
Click the `Code` tab. The `Code` tab has two modes:
4531

4632
| Mode | Description |
4733
|------|-------------|
48-
| **Code Edit** (default) | Write and edit code in the Monaco editor |
49-
| **Code Upload** | Upload a pre-built `.nupkg` file directly |
34+
| **Editor** | Write and edit code in the Monaco editor |
35+
| **Upload** | Upload a pre-built `.nupkg` file. Create this file by saving code created with the `Editor` or using the [Visual Studio](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Visual-Studio) project. |
5036

5137
---
5238

53-
## File Navigation
39+
## Editor
40+
41+
![editor-full-editor](images/editor-full-editor.png)
5442

55-
In **Code Edit** mode, a dropdown at the top of the editor lists all files in the job package. You can switch between files to edit them.
43+
44+
In **Editor** mode, the `Languge` dropdown allows you to switch beteen coding in `C#` or `Python`. The `File` dropdown lists all files in the job package. You can switch between files to edit them.
5645

5746
### C# Job Files
5847

@@ -141,7 +130,9 @@ Dependencies are resolved at compilation time. Transitive dependencies (dependen
141130

142131
## AI Code Assistant
143132

144-
The AI Code Assistant is available in **Code Edit** mode. Click the **AI** button in the editor toolbar to open the chat dialog.
133+
![editor-full-editor](images/ai-chat-box.png)
134+
135+
The AI Code Assistant is available in **Code Edit** mode. Click the **AI** button in the editor toolbar to open the chat dialog. **Note:** For best performance use Claude Opus 4.6 or higher as the AI model.
145136

146137
### Capabilities
147138

41.1 KB
Loading

wiki-content/images/code-tab.png

16.1 KB
Loading
1.62 KB
Loading
10.5 KB
Loading
358 KB
Loading
40.5 KB
Loading

0 commit comments

Comments
 (0)