sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-05-27 00:55:16 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add startup flow diagram and document new config options (#90)

Browse Source
This commit is contained in:
Kyle Yasuda
2026-05-26 23:51:36 -07:00
committed by GitHub
parent 5b44981688
commit efe50ed1e4
6 changed files with 105 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changes/docs-startup-flow-config-options.md
+7
View File
@@ -0,0 +1,7 @@
type: changed
area: docs
- Documented all config options that were present in `config.example.jsonc` but missing from the configuration reference: `subtitleStyle.primaryDefaultMode`, `stats.markWatchedKey`, `immersionTracking.lifetimeSummaries.*`, and all seven `mpv.*` launcher options (`socketPath`, `backend`, `autoStartSubMiner`, `pauseUntilOverlayReady`, `subminerBinaryPath`, `aniskipEnabled`, `aniskipButtonKey`).
- Added a **Playback Startup Flow** diagram to the Architecture page showing how the managed launch (`subminer` CLI, app, Windows shortcut) injects the plugin, establishes the IPC socket, and brings up the overlay via the two convergent triggers.
- Added a **Runtime Sockets** section and diagram to the IPC + Runtime Contracts page showing the mpv IPC socket and app control socket topology.
- Added cross-reference pointers in the MPV Plugin and Troubleshooting pages.