From 4be3ecf7acea5e77a245ca6199ed8e9a9db64339 Mon Sep 17 00:00:00 2001 From: sudacode Date: Sun, 22 Feb 2026 02:14:49 -0800 Subject: [PATCH] docs: refresh stale guidance and shortcut references --- README.md | 1 + docs/development.md | 12 ------- docs/installation.md | 1 + docs/shortcuts.md | 3 +- ...codex-docs-review-20260222T094009Z-g8p2.md | 33 +++++++++++++++++++ docs/troubleshooting.md | 2 +- 6 files changed, 38 insertions(+), 14 deletions(-) create mode 100644 docs/subagents/agents/codex-docs-review-20260222T094009Z-g8p2.md diff --git a/README.md b/README.md index e2f1239..71b8322 100644 --- a/README.md +++ b/README.md @@ -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 | | diff --git a/docs/development.md b/docs/development.md index e546762..c6c5c32 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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. diff --git a/docs/installation.md b/docs/installation.md index 202d963..9b4b341 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 | diff --git a/docs/shortcuts.md b/docs/shortcuts.md index 44e5de4..4ce1285 100644 --- a/docs/shortcuts.md +++ b/docs/shortcuts.md @@ -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 diff --git a/docs/subagents/agents/codex-docs-review-20260222T094009Z-g8p2.md b/docs/subagents/agents/codex-docs-review-20260222T094009Z-g8p2.md new file mode 100644 index 0000000..fef7092 --- /dev/null +++ b/docs/subagents/agents/codex-docs-review-20260222T094009Z-g8p2.md @@ -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. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 9c9c7ef..626c54c 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -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**