Skip to content

docs: add Practice mode user guide#1

Open
pliski wants to merge 1 commit into
beatboxjs:mainfrom
pliski:practice
Open

docs: add Practice mode user guide#1
pliski wants to merge 1 commit into
beatboxjs:mainfrom
pliski:practice

Conversation

@pliski

@pliski pliski commented Jun 4, 2026

Copy link
Copy Markdown

Companion to the Practice-mode proposal (discussion: beatboxjs/ror-player#150;
code: beatboxjs/ror-player#151). Draft, for discussion — see the issue for context.

What this adds

A user-guide page for the new Practice mode (companion to the app PR
beatboxjs/ror-player#151).

The page (src/guide/user/practice.md) walks through:

  • getting started (mic + headphones, picking a tune / part / instrument),
  • the Instrument vs Band practice modes,
  • reading the live feedback (score, timing meter, session totals),
  • the notation key — green / amber / red strike-through (miss) / dotted outline (extra),
  • the settings (speed, latency calibration, sensitivity, difficulty),
  • and how the score is understood (qualitatively; latency vs drift).

It also wires the page into the sidebar (config.ts), the introduction index
(README.md), and registers the microphone icon (client.ts).

yarn build passes with no dead links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant