Skip to content

Commit 5fb8ec2

Browse files
authored
docs: align guided export workflow (#8)
1 parent a766b26 commit 5fb8ec2

21 files changed

Lines changed: 587 additions & 45 deletions

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,25 @@ docs/*
9191
docs/images/*
9292
!docs/images/DVPE_Stitch_Neon_GUI.png
9393
!docs/images/DVPE_Original_Field_Additive_Synth.png
94+
!docs/images/tutorials/
95+
docs/images/tutorials/*
96+
!docs/images/tutorials/advanced-export-settings.png
97+
!docs/images/tutorials/custom-block-create-dialog.png
98+
!docs/images/tutorials/experimentator-design-controls.png
99+
!docs/images/tutorials/export-cpp-preview.png
100+
!docs/images/tutorials/field-mapping-matrix.png
101+
!docs/images/tutorials/field-mapping-patch.png
102+
!docs/images/tutorials/field-mapping-surface.png
103+
!docs/images/tutorials/hardware-platform-configuration.png
104+
!docs/images/tutorials/inspector-parameters-connectivity.png
105+
!docs/images/tutorials/stitch-neon-design-controls.png
106+
!docs/tutorials/
107+
docs/tutorials/*
108+
!docs/tutorials/README.md
109+
!docs/tutorials/CUSTOM_BLOCKS_AND_REUSE.md
110+
!docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md
111+
!docs/tutorials/GETTING_STARTED_FIRST_PATCH.md
112+
!docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md
94113
!docs/user-guide/
95114
docs/user-guide/*
96115
!docs/user-guide/README.md

README.md

Lines changed: 61 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,44 @@ npm ci
3333
npm run dev -- --open
3434
```
3535

36+
## Learn DVPE by building
37+
38+
The tutorials form a short path from first launch through Inspector review,
39+
hardware mapping, export, reusable blocks, and visual customization. Each one
40+
uses the current interface and can be completed independently.
41+
42+
| Tutorial | Time | You will finish with |
43+
| --- | ---: | --- |
44+
| [Build your first patch](docs/tutorials/GETTING_STARTED_FIRST_PATCH.md) | 10 min | A saved source-to-output graph and a clear export boundary. |
45+
| [Inspect, map hardware, and export](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md) | 15–20 min | A reviewed graph, stored Daisy target, and C++/Makefile package. |
46+
| [Map a patch to Daisy Field](dvpe_CLD/examples/field_mapping_subtractive_tutorial.md) | 10–15 min | A working four-layer Field control map based on the included example. |
47+
| [Create and reuse a custom block](docs/tutorials/CUSTOM_BLOCKS_AND_REUSE.md) | 15–20 min | A reusable block with chosen public ports and parameters. |
48+
| [Choose and tune an interface design](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md) | 10 min | A readable Stitch Neon or Experimentator preset. |
49+
50+
[Open the full tutorial index](docs/tutorials/README.md), or begin with the
51+
first patch tutorial. The completed Field example below shows the same basic
52+
source → processing → output flow used throughout the series.
53+
54+
![Completed Field Mapping tutorial patch](docs/images/tutorials/field-mapping-patch.png)
55+
56+
## Inspect, target, and export
57+
58+
The normal handoff is **Inspector → Hardware → Export C++**. **Advanced** is an
59+
optional external-AI review pass, not a replacement for compilation or hardware
60+
validation. Follow the complete
61+
[Inspector, Hardware, and Export tutorial](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md)
62+
for the step-by-step workflow.
63+
64+
| Inspector | Hardware |
65+
| --- | --- |
66+
| Edit the selected block's identity and parameters, enable CV inputs, and trace every accepted connection. | Select Daisy Seed, Pod, or Field; then review pin, peripheral, and Field-surface mappings stored with the project. |
67+
| ![Inspector parameters and connectivity](docs/images/tutorials/inspector-parameters-connectivity.png) | ![Hardware platform configuration](docs/images/tutorials/hardware-platform-configuration.png) |
68+
69+
| Export C++ | Advanced |
70+
| --- | --- |
71+
| Review the target header and generated callback before downloading the C++ source and Makefile ZIP. | In Experimentator, configure provider, model, and browser-only API key under **Inspector → Design → AI Export Settings**, then compare the raw and corrected previews. |
72+
| ![Generated C++ preview for Daisy Field](docs/images/tutorials/export-cpp-preview.png) | ![Advanced Export settings with no API key stored](docs/images/tutorials/advanced-export-settings.png) |
73+
3674
## What works now
3775

3876
- A catalog of 174 runtime blocks in 9 categories, with 329 parameters and
@@ -45,7 +83,7 @@ npm run dev -- --open
4583
modules, and port binding.
4684
- `.dvpe` save/load, autosave recovery, recent projects, and embedded custom
4785
block definitions.
48-
- Daisy-oriented C++, headers, and Makefile generation, downloaded as a ZIP.
86+
- Daisy-oriented C++ source and Makefile generation, downloaded as a ZIP.
4987
- Hardware/Field mapping, conflict checks, polyphonic code paths, and an
5088
optional Advanced Export pass using a user-supplied AI API key.
5189

@@ -65,7 +103,8 @@ between them with the design button in the top bar.
65103

66104
Stitch Neon and Experimentator are fine-tunable in **Inspector → Design**.
67105
Changes are applied live, and both modes support saved presets. See the
68-
[complete Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
106+
[design tuning tutorial](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md) or
107+
the [complete Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
69108
for the full workflow, controls, shortcuts, export steps, and troubleshooting.
70109

71110
## Current state
@@ -91,18 +130,20 @@ custom blocks and nested internals. May added Field hardware mapping,
91130
polyphonic generation, persistence, Neon design work, and a compact polyphonic
92131
Grainlet workflow. July added reproducible dependency locking, tracked codegen
93132
fixtures, and CI coverage. In September 2026 the public product description,
94-
block catalog, GUI documentation, dependency lock, lint contract, and Windows
95-
startup path were reconciled against the running application.
133+
block catalog, guided tutorials, GUI documentation, locked startup path, and
134+
export-to-hardware handoff were reconciled against the running application.
96135

97-
## Tutorials and documentation
136+
## Documentation
98137

99-
| Start here | What it covers |
100-
| --- | --- |
101-
| [Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md) | Complete GUI workflow: add, connect, edit, design, map hardware, save, and export. |
102-
| [Daisy Field Mapping tutorial](dvpe_CLD/examples/field_mapping_subtractive_tutorial.md) | A guided subtractive-synth patch with knobs, keys, shift layers, conflicts, and C++ export. |
103-
| [Glassmorphism design tutorial](dvpe_DESIGN/dvpe_glassmorphism_ai_guide.md) | A visual design study for tuning transparent blocks, wire glow, and readable UI chrome. |
104-
| [Block catalog reference](docs/reference/DVPE_Diagram_Block_Reference.md) | The generated 174-block inventory, categories, parameters, ports, and intended uses. |
105-
| [User guide index](docs/user-guide/README.md) | A compact entry point to all end-user documentation. |
138+
- [Tutorial index](docs/tutorials/README.md)
139+
- [Build your first patch](docs/tutorials/GETTING_STARTED_FIRST_PATCH.md)
140+
- [Inspect, map hardware, and export](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md)
141+
- [Create and reuse custom blocks](docs/tutorials/CUSTOM_BLOCKS_AND_REUSE.md)
142+
- [Tune the three interface designs](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md)
143+
- [User guide index](docs/user-guide/README.md)
144+
- [Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
145+
- [Block catalog reference](docs/reference/DVPE_Diagram_Block_Reference.md)
146+
- [Daisy Field Mapping example tutorial](dvpe_CLD/examples/field_mapping_subtractive_tutorial.md)
106147

107148
## Development
108149

@@ -119,13 +160,15 @@ npm run lint
119160
The fixed development URL is `http://127.0.0.1:1420/`. If that port is already
120161
used by another application, stop that application before launching DVPE.
121162

122-
## Repository scope
163+
## Repository scope and privacy
123164

124-
This repository is the original development base and retains its public
125-
history, design studies, planning material, dashboards, and agent-support
126-
files. Ignored local-only copies of `DaisyExamples/` and `noderr/` are not part
127-
of a normal public clone. For a smaller product-only checkout without those
128-
development layers, use the curated [DVPE sharing repository](https://github.com/Denys/DVPE).
165+
This is the original development base. It retains its public history, design
166+
studies, planning material, dashboards, and agent-support files. Ignored
167+
local-only copies of `DaisyExamples/` and `noderr/` are not part of a normal
168+
public clone. Curated user documentation and screenshots are explicitly
169+
allowlisted; credentials, local settings, and other ignored development data
170+
remain excluded. For a smaller product-only checkout with a fresh history, use
171+
the curated [DVPE sharing repository](https://github.com/Denys/DVPE).
129172

130173
## License
131174

74.8 KB
Loading
59.4 KB
Loading
73 KB
Loading
70.1 KB
Loading
62.8 KB
Loading
61.4 KB
Loading
55.5 KB
Loading
48.1 KB
Loading

0 commit comments

Comments
 (0)