docs: refresh stale guidance and shortcut references

This commit is contained in:
2026-02-22 02:14:49 -08:00
parent f6e7dd496a
commit 4be3ecf7ac
6 changed files with 38 additions and 14 deletions

View File

@@ -77,6 +77,7 @@ subminer video.mkv
| Required | Optional |
| ------------------------------------------ | ---------------------------- |
| `mpv` with IPC socket | `yt-dlp` |
| `ffmpeg` | `guessit` (better AniSkip title/episode detection) |
| `mecab` + `mecab-ipadic` | `fzf` / `rofi` |
| Linux: `hyprctl` or `xdotool` + `xwininfo` | `chafa`, `ffmpegthumbnailer` |
| macOS: Accessibility permission | |

View File

@@ -94,21 +94,9 @@ bun run check:runtime-cycles:strict
Expected success output includes:
- `[OK] hotspot budget check (strict) — no hotspots over limit`
- `[OK] main runtime fan-in (strict) — ...`
- `[OK] runtime cycle check (strict) - ... no cycles detected`
Hotspot budget baselines (2026-02-22):
| File | Baseline LOC | Limit LOC |
| ----------------------------------------- | ------------ | --------- |
| `src/main.ts` | 2978 | 3150 |
| `src/config/service.ts` | 116 | 140 |
| `src/core/services/tokenizer.ts` | 232 | 260 |
| `launcher/main.ts` | 101 | 130 |
| `src/config/resolve.ts` | 33 | 55 |
| `src/main/runtime/composers/contracts.ts` | 13 | 30 |
Troubleshooting guardrail failures:
- Main fan-in failure: move runtime imports behind `src/main/runtime/domains/*` or composer barrels.

View File

@@ -30,6 +30,7 @@
| rofi | GUI-based video picker |
| chafa | Thumbnail previews in fzf |
| ffmpegthumbnailer | Generate video thumbnails for picker |
| guessit | Better AniSkip title/season/episode parsing for file playback |
| alass | Subtitle sync engine (preferred) |
| ffsubsync | Subtitle sync engine (fallback) |
| Bun | Required for the `subminer` wrapper script |

View File

@@ -92,7 +92,8 @@ When the mpv plugin is installed, all commands use a `y` chord prefix — press
| `y-o` | Open Yomitan settings |
| `y-r` | Restart overlay |
| `y-c` | Check overlay status |
| `y-d` | Toggle overlay DevTools (dev/debug use) |
When the overlay has focus, press `y` then `d` to toggle DevTools (debugging helper).
## Drag-and-Drop

View File

@@ -0,0 +1,33 @@
# Agent: `codex-docs-review-20260222T094009Z-g8p2`
- alias: `codex-docs-review`
- mission: `Review README/docs for drift vs current code/scripts; patch stale or missing documentation.`
- status: `done`
- branch: `main`
- started_at: `2026-02-22T09:40:09Z`
- heartbeat_minutes: `5`
## Current Work (newest first)
- [2026-02-22T09:43:52Z] handoff: docs-only drift fixes landed; `bun run docs:build` passes.
- [2026-02-22T09:42:40Z] test: `bun run docs:build` passed.
- [2026-02-22T09:41:50Z] progress: patched stale guardrail docs, corrected DevTools shortcut docs, and documented `guessit` as optional AniSkip metadata enhancer.
- [2026-02-22T09:40:09Z] intent: initialize session bookkeeping; audit README.md + docs/* against package scripts and current features.
## Files Touched
- `docs/subagents/agents/codex-docs-review-20260222T094009Z-g8p2.md`
- `README.md`
- `docs/development.md`
- `docs/installation.md`
- `docs/mpv-plugin.md`
- `docs/shortcuts.md`
- `docs/troubleshooting.md`
## Assumptions
- `Backlog.md` not configured in repo root, so no mandatory backlog ticket linkage for this pass.
- Existing dirty worktree from other tasks should remain untouched.
## Open Questions / Blockers
- None.
## Next Step
- Await user review or follow-up docs scope.

View File

@@ -68,7 +68,7 @@ Shown when SubMiner tries to update a card that no longer exists, or when AnkiCo
- Renderer errors now trigger an automatic recovery path. You should see a short toast ("Renderer error recovered. Overlay is still running.").
- Recovery closes any open modal and restores click-through/shortcuts automatically without interrupting mpv playback.
- If errors keep recurring, toggle the overlay's DevTools using the `y-d` mpv chord (or `F12` when running with `--dev`) and inspect the `renderer overlay recovery` error payload for stack trace + modal/subtitle context.
- If errors keep recurring, toggle the overlay's DevTools using overlay chord `y` then `d` (or global `F12`) and inspect the `renderer overlay recovery` error payload for stack trace + modal/subtitle context.
**Overlay is on the wrong monitor or position**