Skip to content

Commit 76aead2

Browse files
d34dmanclaude
andcommitted
docs: use Starlight FileTree component for component hierarchy sections
Convert ASCII tree diagrams to Starlight's <FileTree> component in architecture-overview and components reference pages (.md → .mdx). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent da9d7cc commit 76aead2

2 files changed

Lines changed: 42 additions & 34 deletions

File tree

apps/docs/src/content/docs/concepts/architecture-overview.md renamed to apps/docs/src/content/docs/concepts/architecture-overview.mdx

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -67,29 +67,33 @@ Import from the most specific module possible to minimize bundle size.
6767

6868
When you mount `mountFlowDropApp()`, this is the component tree:
6969

70-
```
71-
App
72-
├── Navbar
73-
│ ├── Logo
74-
│ ├── WorkflowName (editable)
75-
│ ├── Save / Export buttons
76-
│ ├── Custom NavbarActions
77-
│ └── ThemeToggle / Settings
78-
├── NodeSidebar
79-
│ ├── Search
80-
│ └── CategoryGroups
81-
│ └── NodeCards (draggable)
82-
├── WorkflowEditor (@xyflow/svelte canvas)
83-
│ ├── Nodes (WorkflowNode, SimpleNode, GatewayNode, etc.)
84-
│ │ └── Ports (input/output handles)
85-
│ ├── Edges (styled by category)
86-
│ └── ConnectionLine
87-
├── ConfigPanel (right side, on node click)
88-
│ ├── NodeHeader (name, type, icon)
89-
│ └── SchemaForm (generated from configSchema)
90-
│ └── FormFields (text, select, code, template, etc.)
91-
└── ToastContainer
92-
```
70+
import { FileTree } from '@astrojs/starlight/components';
71+
72+
<FileTree>
73+
74+
- App
75+
- Navbar
76+
- Logo
77+
- WorkflowName (editable)
78+
- Save / Export buttons
79+
- Custom NavbarActions
80+
- ThemeToggle / Settings
81+
- NodeSidebar
82+
- Search
83+
- CategoryGroups
84+
- NodeCards (draggable)
85+
- WorkflowEditor (@xyflow/svelte canvas)
86+
- Nodes (WorkflowNode, SimpleNode, GatewayNode, etc.)
87+
- Ports (input/output handles)
88+
- Edges (styled by category)
89+
- ConnectionLine
90+
- ConfigPanel (right side, on node click)
91+
- NodeHeader (name, type, icon)
92+
- SchemaForm (generated from configSchema)
93+
- FormFields (text, select, code, template, etc.)
94+
- ToastContainer
95+
96+
</FileTree>
9397

9498
`mountWorkflowEditor()` mounts just the canvas — no navbar, no sidebar.
9599

apps/docs/src/content/docs/reference/components.md renamed to apps/docs/src/content/docs/reference/components.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -332,14 +332,18 @@ const app = await mountFlowDropApp(document.getElementById('editor'), {
332332

333333
## Component Hierarchy
334334

335-
```
336-
App
337-
├── Navbar (Logo, workflow name, save/export, custom actions)
338-
├── NodeSidebar (search, category groups, draggable node cards)
339-
├── WorkflowEditor (SvelteFlow canvas)
340-
│ └── UniversalNode
341-
│ ├── NodeStatusOverlay
342-
│ └── [Node Component] (WorkflowNode, SimpleNode, etc.)
343-
└── ConfigSidebar
344-
└── ConfigForm (JSON Schema form with template variables)
345-
```
335+
import { FileTree } from '@astrojs/starlight/components';
336+
337+
<FileTree>
338+
339+
- App
340+
- Navbar (Logo, workflow name, save/export, custom actions)
341+
- NodeSidebar (search, category groups, draggable node cards)
342+
- WorkflowEditor (SvelteFlow canvas)
343+
- UniversalNode
344+
- NodeStatusOverlay
345+
- [Node Component] (WorkflowNode, SimpleNode, etc.)
346+
- ConfigSidebar
347+
- ConfigForm (JSON Schema form with template variables)
348+
349+
</FileTree>

0 commit comments

Comments
 (0)