Skip to content

Add First Session quickstart guide and cross-links - #15

Merged
bseverns merged 2 commits into
mainfrom
codex/add-first-session-documentation-and-links
Jan 5, 2026
Merged

bseverns merged 2 commits into
mainfrom
codex/add-first-session-documentation-and-links

Conversation

@bseverns

@bseverns bseverns commented Jan 5, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Provide an immediate, teachable 10‑minute onboarding ritual so instructors can verify the full hardware → firmware → serial → OSC → visualizer pipeline.
  • Make it trivial to recover when you only have a short setup window by surfacing the fastest end‑to‑end steps from the bridge doc.
  • Offer a minimal, deterministic test packet and expected visual response so users can validate the system quickly.
  • Correct the p5 visualizer path reference so the browser sketch is discoverable.

Description

  • Add docs/FirstSession.md containing a step‑by‑step quickstart, the known‑good packet {"gesture":"pluck","value":96}, and the expected visual response (PLUCK and velocity ≈ 96/127).
  • Insert a First Session heading in README.md linking to docs/FirstSession.md and summarizing the 10‑minute script.
  • Add an If you only have 10 minutes pointer to docs/OSCSerialBridge.md that directs readers to docs/FirstSession.md.
  • Fix the p5 visualizer reference in the new doc to software/p5js/sketch.js.

Testing

  • No automated tests were executed because this is a documentation‑only change.

Codex Task

@bseverns
bseverns merged commit ec491a8 into main Jan 5, 2026
8 checks passed
@bseverns
bseverns deleted the codex/add-first-session-documentation-and-links branch January 5, 2026 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant