Docs reframing - #66
Merged
Merged
Conversation
The timing_test tool depended on the unimplemented ZMQ PUB event system (#19) for its command-to-photon measurement path and was not functional end to end. Remove the tool and trim its references from the docs: - delete tools/timing_test/ in full - drop the "Hardware timing test" section from docs/concepts/frame-timing.md - trim FRAME_TIMING.md to the two implemented layers (FrameStats, egui HUD) plus the planned Phase 3/4 roadmap, removing the deleted Layer 3 tool section and workflow Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Recast the docs around setup-then-execution instead of two parallel "ways to control vstimd". The command API and config API are now presented as two setup APIs that prepare stimuli and trigger-armed animations, while the Virtual Trigger Line framework is framed as vstimd's central operating model that produces the precisely-timed stimulation. - tutorial/index.md: retitle to "How vstimd works: setup, then triggers"; split into scene setup (command + config APIs) and trigger-driven execution (VTL); regroup the decision guide - index.md: lead with the trigger-driven model; recast "two ways to control" as "setup, then triggers" - why-vstimd.md: sharpen the command-driven-vs-trigger-driven distinction; add BonVision/Bonsai as the nearest reactive kin and contrast the desktop-OS substrate with bare-metal Linux - mkdocs.yml / saving-loading.md: nav labels and cross-links to match Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
No description provided.