docs: new-user tutorial path + manual test plan - #343
Open
jeffcrouse wants to merge 3 commits into
Open
Conversation
Two additions from the pre-v0.1.2 audit prep: TUTORIALS — a GUI-first, new-user learning path in examples/tutorials/ (01..07): Meet Vivid -> First sound -> First visual -> Make it react -> Perform it -> Author an operator -> Save & share. Each teaches the interface by doing, ends each step with a "You should see/hear" checkpoint, and carries a "Try it with MCP" aside so the reader graduates from clicking to driving Vivid over the control server. README.md rewritten as a two-track index (learning path + advanced follow-ups: mcp-native-first-project / live-shader-edit / project-cpp-operator). Tutorial 06 threads the north star (author your own op) and the new authoring surface (get_operator_authoring_guide, errored_ops). MANUAL TEST PLAN — docs/testing/manual-test-plan.md: a human walkthrough for a release-gate audit that ctest can't cover (actually seeing/hearing the output): launch + core flows, all 15 demos (with per-demo expectations), the project-only fixtures, the 38 per-op examples, the 7 learning-path tutorials + 3 advanced, the ADR-0037 showcase harness, the export paths, the MCP/authoring surface, and a known-instability watch-list, with PASS/WARN/FAIL sign-off. Follow-up: capture the screenshots each tutorial references (img/*.png) against the shipping UI. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QB6eSNJE55ru3g4vsL77GT
jeffcrouse
enabled auto-merge (squash)
August 12, 2026 01:08
…erface) Real full-UI screenshots for the 7 learning-path tutorials, captured with the new capture_interface control tool (the app's own composited window framebuffer) and downscaled to 1600px. Each stages the concept with a fitting demo project: overview<-pulse, first-sound<-neon, first-visual<-crystal, make-it-react<-spectrum, perform-it<-grid, author-op<-song-sketch, save-and-share<-storm. Note: composition varies by project (some have the node-graph scrolled); a few may be worth reframing in a later pass, but they're real, on-brand, and replace the placeholders. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QB6eSNJE55ru3g4vsL77GT
Contributor
Production gate (core): ✅ PASS
|
Regenerated with layout_graph applied (control-edge-aware placement + roomier spacing from #346), so the node graphs read as clean left→right flow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QB6eSNJE55ru3g4vsL77GT
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two docs from the pre-v0.1.2 audit prep.
New-user tutorial learning path (
examples/tutorials/)A GUI-first onboarding path that teaches the interface by doing, then graduates the reader to MCP:
Each step ends with a ✓ You should see/hear checkpoint and a Try it with MCP aside (the asides escalate from light reads to real driving —
connect_mapping,scaffold_project_shader_operator,export_av).README.mdis rewritten as a two-track index; the existing three tutorials become advanced follow-ups. Tutorial 06 threads the authoring posture + the newget_operator_authoring_guide/errored_opssurfacing.Manual test plan (
docs/testing/manual-test-plan.md)A human walkthrough for a release-gate audit that
ctestcan't cover — seeing and hearing the output: launch + core flows, all 15 demos (per-demo expectations), the project-only fixtures, the 38 per-op examples, the 7 learning-path tutorials + 3 advanced, the ADR-0037 showcase harness, the export paths, the MCP/authoring surface, and a known-instability watch-list — with PASS/WARN/FAIL sign-off.Follow-up (not in this PR)
Capture the screenshots each tutorial references (
img/*.png) against the shipping UI.🤖 Generated with Claude Code
https://claude.ai/code/session_01QB6eSNJE55ru3g4vsL77GT