Document the sleep timer redesign - #19
Merged
Merged
Conversation
…equence veto Document the two matching fixes: metadata extraction now prefers the title tag when it extends the album with a real subtitle (the Audible series-in-album shape), and pkg/match disqualifies a same-series candidate on a sequence conflict only when both titles are bare "series + number".
Shake now extends a running sleep timer instead of cancelling it, so the User Guide's "shake to cancel" claims were wrong in two places. Covers what the fade does and does not apply to (set-time timers fade over their last 30 seconds, end-of-chapter timers play out at full volume), the "Keep listening" button as the web's only route, the countdown freezing while paused with its 20 minute reset and 2 hour abandon, and the new Auto sleep timer setting with its arming rules. Developer docs cover the timer's phase machine, the required setVolume on PlaybackService, the shake hook mounting at the root rather than in the player modal, the auto sleep controller and its session memory, and the shared player-store test double.
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.
Docs for KodeStar/audiosilo-frontend#59, where shake now extends a running sleep timer instead of cancelling it.
User Guide
The "shake to cancel" claim was wrong in two places (
listening/playback.mdandlistening/mobile-apps.md) and is corrected, not merely supplemented. Added:listening/playback.mdandlistening/account.mdDeveloper Docs
frontend/playback.mdcovers the timer's phase machine and thesyncFadereconciler, the freeze representation and why it must survive the JS runtime being suspended, theallowEndOfBooksplit between an automatic arm and a shake, the auto sleep controller with its session memory and no-re-arm-loop argument, and the required (not optional)setVolumeonPlaybackService.Several stale claims a reviewer caught are fixed: it described
setVolumeas optional in four places whentypes.tsdeclares it required and explicitly rejects that design, namedapplyFadeGainafter it becamesyncFade, described the phase as derived when it is stored, and saiduseShakeToExtendis called fromplayer-view.tsxwhen it is deliberately mounted at the root so shake works on a locked phone with no player screen.frontend/testing.mddocuments the shared player-store test double, including its deliberate divergences from the real store, and records thatrenderandfireEventare both async in RNTL 14.Gate
npm run buildpasses, which throws on broken links and anchors.Known follow-up
static/img/screenshots/web-player/settings.pngis now out of date, since the Settings screen has a new Sleep timer section. Regenerating needs a running server, so it is a separate pass.