Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 15 additions & 11 deletions src/content/docs/architecture/data-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This page traces the data flow through the entire system for the most important

This is the primary flow -- a user creates a visual workflow and deploys it to Kubernetes.

![Workflow API Flow](../../../assets/images/architecture/data-flow/workflow-api-flow.png)

### Phase 1: Design

![Workflow Creation - Design Phase](../../../assets/images/architecture/data-flow/workflow-creation.png)
Expand Down Expand Up @@ -67,20 +69,22 @@ After deployment, the core maintains active watchers on Kubernetes resources:

![Real-Time Resource Monitoring](../../../assets/images/architecture/data-flow/realtime-monitoring.png)

### Resource Watch Pipeline

![Resource Watch Pipeline](../../../assets/images/architecture/data-flow/resource-watch-pipeline.png)

### SSE Status Stream

![SSE Status Stream](../../../assets/images/architecture/data-flow/workflow-status-stream.png)

### Terminal Exec Session

![Terminal Exec Session](../../../assets/images/architecture/data-flow/terminal-exec-session.png)

## Version Control Flow

Workflows support git-like versioning:

```
Save Workflow → Auto-increment version → Store snapshot in workflow_versions collection
├── Compare: GET /versions/compare?v1=1&v2=3
│ → Returns NodeDiff[] and EdgeDiff[]
│ → UI shows side-by-side CompareCanvas
└── Restore: POST /versions/:v/restore
→ Creates new version with old content
→ Updates workflow.nodes and workflow.edges
```
![Workflow Versioning](../../../assets/images/architecture/data-flow/workflow-versioning.png)

Choose a reason for hiding this comment

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

medium

For better accessibility, the alt text for this image should be more descriptive. Currently, it just says "Workflow Versioning". A good alt text should briefly describe the image's content for screen readers. This suggestion also applies to the other new images in this file.

For example, the previous ASCII diagram described the flow of saving, comparing, and restoring versions. The alt text could reflect that.

Suggested change
![Workflow Versioning](../../../assets/images/architecture/data-flow/workflow-versioning.png)
![Workflow versioning flow diagram showing save, compare, and restore operations.](../../../assets/images/architecture/data-flow/workflow-versioning.png)


Each version stores a complete snapshot of nodes and edges, enabling full rollback and diff comparison.
8 changes: 1 addition & 7 deletions src/content/docs/architecture/ui-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,13 +208,7 @@ WorkflowCanvas.tsx

Each node on the canvas has a `data` property matching a TypeScript interface (defined in `lib/types/nodes.ts`). When a user edits node settings:

```
User edits in Settings Panel
→ WorkflowStore.updateNodeData()
→ nodeUpdateHandler callback
→ React Flow setNodes()
→ Canvas re-renders
```
![Node Data Flow](../../../assets/images/architecture/ui-frontend/node-data-flow.png)

Choose a reason for hiding this comment

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

medium

To improve accessibility, the image's alt text should be more descriptive. Instead of just "Node Data Flow", it could summarize the flow it represents. The previous ASCII diagram showed the sequence from a user edit to a canvas re-render.

Suggested change
![Node Data Flow](../../../assets/images/architecture/ui-frontend/node-data-flow.png)
![Diagram of the node data flow, from user edit in settings panel to canvas re-render via the workflow store and React Flow.](../../../assets/images/architecture/ui-frontend/node-data-flow.png)


### Secret Handling

Expand Down
11 changes: 0 additions & 11 deletions src/content/docs/guides/example.md

This file was deleted.

11 changes: 0 additions & 11 deletions src/content/docs/reference/example.md

This file was deleted.