docs: showcase packages with screenshots and demo media - #114
Open
NachoVazquez wants to merge 1 commit into
Open
NachoVazquez wants to merge 1 commit into
NachoVazquez wants to merge 1 commit into
Conversation
Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
This was referenced Sep 5, 2026
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
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.
TL;DR
Every package README was text-only — six solid products with zero visual proof. This PR gives each README a hero image or demo GIF, real screenshots captured from live Pi/OpenCode/CLI sessions, and a landing-page structure (hero → install → what you get → details), with all factual content preserved.
Files to review (15, +330 / −368):
docs/media/**(new media, start here)-- INSERT --, apnea CLI GIF.packages/pi-music-dock/README.mdpackages/music-core/README.mdstepEngine/displayLevelexample.packages/apnea/README.mdREADME.mdHow
docs/media/<package>/, outside every npm tarball. All sixverify-packexact-match gates still pass. READMEs reference assets viaraw.githubusercontent.comURLs so npmjs.com renders them; they resolve once this merges to main (they 404 on this PR until then).PI_CODING_AGENT_DIRrunning local 0.1.2 with tokyo-night-moon; OpenCode sidebar/compact from a live session; GIFs generated with VHS (apnea help/status, and the waveform engine's playing state).Reviewer notes
displayLevel(level, index, playing)in the new music-core example matches the real signature, not the engine-taking guess.<img>/<a>, not markdown, because GitHub does not parse markdown inside HTML blocks.Tests
bun run format:checkandbun test scriptspass; all sixpack:checkgates verified. No product code changed.