vizmatic 0.6.1 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -93,6 +93,20 @@ npx vizmatic ./frame.tsx --out ./figures --theme dark,light --format both
93
93
 
94
94
  Read [Diagrams and density](https://bvolpato.github.io/vizmatic/docs/diagrams.html) and the [figures reference](https://bvolpato.github.io/vizmatic/docs/figures.html), or browse the [component catalog](https://bvolpato.github.io/vizmatic/components.html).
95
95
 
96
+ ## Teaching with a checked canvas
97
+
98
+ `createTeachingCanvas(painter)` composes animated explanations through your host's checked drawing methods. Its components return computed state so labels and geometry follow the same calculation. Bind progress and answer reveals separately to the narration.
99
+
100
+ | Component | A worked example |
101
+ |---|---|
102
+ | `vectorAccumulation` | [Retain momentum, add an opposing gradient, then reveal the resultant](examples/_teaching/teaching-weighted-vector.ts) |
103
+ | `categoricalSampling` | [Watch a rare category disappear from a supplied finite sample](examples/_teaching/categorical-tail-loss.ts) |
104
+ | `routedTransfer` | [Carry a value around visible obstacles](examples/_teaching/teaching-routed-transfer.ts) |
105
+ | `byteDifference` | [Locate a changed byte while retaining offsets and escaped control characters](examples/_teaching/teaching-byte-diff.ts) |
106
+ | `tokenHistory` | [Drop and rebuild KV while preserving accepted and emitted tokens](examples/_teaching/teaching-token-history.ts) |
107
+
108
+ Each example supplies its own data and timing. Inspect prediction frames, moving states, and settled results at the delivery resolution. The [canvas guide](https://bvolpato.github.io/vizmatic/docs/tsx-animation.html) describes the painter contract and component limits.
109
+
96
110
  ## For coding agents
97
111
 
98
112
  Install the skill. It teaches the engine, the object catalog, and the check workflow.
@@ -120,7 +134,7 @@ Agents can also read [`llms.txt`](https://bvolpato.github.io/vizmatic/llms.txt),
120
134
 
121
135
  ## Package installation
122
136
 
123
- Vizmatic 0.6.1 bundles its tested Satori renderer and uses patched `fflate` 0.7.5. Consumer dependency overrides are no longer required.
137
+ Vizmatic 0.7.0 bundles its tested Satori renderer and uses patched `fflate` 0.7.5. Consumer dependency overrides are no longer required.
124
138
 
125
139
  For pnpm 11, allow esbuild's install script in the root `pnpm-workspace.yaml`. The CLI uses esbuild to compile films and frames:
126
140
 
package/ROADMAP.md CHANGED
@@ -42,11 +42,11 @@ This page states what Vizmatic can do now and what comes next. Vizmatic aims to
42
42
  ### Figures
43
43
 
44
44
  - C4 semantics: one reusable model with context, container, component, deployment, and dynamic views.
45
- - UML class and component diagrams, state machines with nested states, and ER diagrams with keys and cardinality.
45
+ - UML class and component diagrams, and state machines with nested states. ER diagrams with keys and cardinality are implemented.
46
46
  - Swimlanes and activity diagrams.
47
47
  - A layout adapter interface with Dagre as the default and ELK as an option. Per-boundary direction and collapsed groups.
48
48
  - Build-time icon packs for GCP and Kubernetes from pinned Apache-2.0 data, as optional modules. User-supplied AWS and Azure adapters until redistribution terms support bundled packs.
49
- - Structured accessibility for charts and other primitives, as graph diagrams have today.
49
+ - Structured accessibility for more scientific and drawing primitives. Charts and entity-relationship diagrams now preserve their semantic summaries in SVG exports.
50
50
  - Wider Mermaid and D2 import, and Structurizr, Kubernetes, and Terraform adapters where semantics map safely.
51
51
 
52
52
  ## Design constraints