Skip to content

docs: dedupe install examples, de-orphan build-output page, refresh agent records#25

Merged
fan-droide merged 2 commits into
mainfrom
docs/install-dedup-build-output
Jun 12, 2026
Merged

docs: dedupe install examples, de-orphan build-output page, refresh agent records#25
fan-droide merged 2 commits into
mainfrom
docs/install-dedup-build-output

Conversation

@fan-droide

Copy link
Copy Markdown
Collaborator

Summary

Documentation cleanup pass (Codex-reviewed), post-1.2.0:

  • docs/install.md — "Providing AudioContext and stream" no longer duplicates the Basic usage code block; it keeps the resource contract prose and the existing-AudioContext/DAW snippet, states the AC-before-getUserMedia ordering rule in prose (was only a code comment), and points to the complete example via the #basic-usage anchor.
  • docs/build-output.md — de-orphaned (it was the docs site's only unreachable page): now linked from the install.md CDN section. Accuracy fixes: legacy-build browser scoping now matches install.md's Legacy IIFE note (Chrome 74–79, Firefox < 72, Safari 14, recording-mode="mediarecorder" only — the page previously contradicted it), and "all files are minified" corrected to the JS bundles only.
  • CLAUDE.mddocs/build-output.md added to the file map (its omission is why the orphan went unnoticed).
  • agents/SESSION_HANDOFF.md — current-state section updated for the completed v1.2.0 release (main branch, CDN pins @1.2.0); mid-flight release warning replaced with the release-complete record; this docs session logged.

Verification

  • npm run docs:build passes (VitePress fails on dead internal links, so both new cross-links are validated).

🤖 Generated with Claude Code

gilpanal and others added 2 commits June 12, 2026 14:07
…gent records

- install.md: remove code block duplicating Basic usage from 'Providing
  AudioContext and stream'; promote AC-before-getUserMedia ordering rule
  to prose; add pointer to #basic-usage
- build-output.md: link from install.md CDN section (was the only orphan
  page on the docs site); align legacy-browser scoping with install.md's
  Legacy IIFE note; 'all files minified' -> JS bundles only
- CLAUDE.md: add docs/build-output.md to file map
- SESSION_HANDOFF.md: current state now reflects main branch, v1.2.0
  released, CDN pins @1.2.0; mid-flight release warning replaced with
  release-complete record; docs cleanup session recorded

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…y review

Histogram moved from Phase 4 to the Phase 8 experimentation toolkit
(user decision). Codex consistency review: all 11 findings addressed —
Phase 4/6 checklists annotated done/superseded/dropped (matrix coverage
of AudioWorklet Float32 + multi-run confirmed by user), AGENTS.md phase
table renumbered (Phase 8 = toolkit, signal types = unnumbered v2 scope)
and recording-mode triple corrected, CODEX_REVIEW.md marked historical
via dated banner + input-gain superseded-note, Phase 6 verification gate
scoped to the six framework pages (host-gain verified via demo panel).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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