Learning Path
The order to read these docs in, from first diagram to custom extension
There are 107 pages here. This page is the shortest route through them, in four stages. Each stage stands on its own; stop when you have what you need.
Table of Contents
Stage 1 — First diagram (1 hour)
1
Installation — configure the private feed, pick a target framework, install
Beep.Skia and run the verification snippet.2
Quick Start — create a
DrawingManager, add ProcessNodes, connect them, and host it in a WinForms form with SkiaHostControl.3
Sample Applications — run the editor sample and try the Templates menu, the palette, validation and export. Everything else in these docs maps to something you can see there.
4
Architecture Overview — the layer model: components, manager, connections, serialization, hosts.
Stage 2 — Real application (a day)
5
SkiaComponent — the component model: geometry,
NodeProperties, ports, the draw entry point, lifecycle.6
DrawingManager — components, connections, selection, viewport, templates, undo.
7
Connection System and Connection Animation — routing modes, labels, multiplicity, data-flow visuals.
8
Interaction Model and Keyboard and Mouse — what the user can do without you writing input code.
9
Serialization — save and load diagrams, schema versioning, custom component types.
10
Theming and Performance — make it look right and keep it fast at scale.
Stage 3 — A diagram family in depth (a day each)
Pick the family you need. Each family page starts with a rendered grid of its node types, so you can see what you are working with before reading a line of code.
| If you build | Read |
|---|---|
| Process flows with generated code or simulation | Flowchart (code generation, simulation) |
| BPMN processes exchanged with modeling tools | Business Process (import/export) |
| Database schemas and migrations | ERD and ERD Enterprise Features (DDL, schema diff, migration scripts) |
| Data pipelines | ETL and ETL Professional Features (lookups, SCD/CDC, expressions, profiling) |
| Threat models | Security (STRIDE, DREAD, MITRE) |
| Project plans | Project Management (CPM, Gantt) |
| Hardware or circuits | ECAD (symbols, electrical rules check) |
| Anything else | The other nine family pages in the sidebar — each follows the same shape: grid, node catalog, ports, features. |
Stage 4 — Automation, extensions and scale
11
Workflow Engine and Automation Nodes — run the diagram you drew.
12
Triggers, Credentials, Data Sources — make it run on a schedule against real data, without secrets in the diagram.
13
Server Execution SKU and Jobs and Results — queue workflows as HTTP jobs and watch their state.
14
Creating Custom Families and Extension SDK — ship your own node types.
15
Marketplace and Collaboration — distribute packages and review diagrams as a team.
16
Architecture & Internals — the registry, rendering pipeline, serialization system and event model, once you need to know how it works inside.
Where to Start by Role
| Role | Shortest path |
|---|---|
| App developer embedding a canvas | Installation → Quick Start → WinForms Controls → Serialization |
| Diagram author / power user | Sample Applications → Keyboard and Mouse → your family page |
| Data engineer | ETL → ETL Professional Features → Data Sources → Workflow Engine |
| DBA / architect | ERD → ERD Enterprise Features → Serialization |
| Security engineer | Security → Validation → Collaboration |
| Extension author | Creating Custom Families → Extension SDK → Marketplace |
| Evaluating the framework | Home (feature tour) → Samples → Performance Guide → API Reference |
Stuck at any point: Getting Help.