mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-05-26 00:55:16 -07:00
sudacode
c02edc90cc
Cross-check every config key, shortcut, default, and command against the current source and fix the drift (mpv.socketPath, auto_start_overlay default, AniSkip TAB key, JLPT N4 color, secondary-sub font/defaults, secondary-sub language behavior, modular mpv plugin layout, and more). Add plain-language intros and first-use definitions across onboarding and integration pages so non-technical readers can follow along. Internal docs/: fix stale module paths in architecture/domains.md, add missing contract entry points and catalog rows, and bump verified dates. Remove the obsolete docs/plans/ directory (its only plan shipped in 0.15.0) and reframe planning.md so plans live with the work, not in docs/.
42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
<!-- read_when: deciding whether work needs a plan or writing one -->
|
|
|
|
# Planning
|
|
|
|
Status: active
|
|
Last verified: 2026-05-23
|
|
Owner: Kyle Yasuda
|
|
Read when: the task spans multiple files, subsystems, or verification lanes
|
|
|
|
## Plan Types
|
|
|
|
- Lightweight plan: small change, a few reversible steps, minimal coordination
|
|
- Execution plan: nontrivial feature/refactor/debugging effort with multiple phases or important decisions
|
|
|
|
## Use a Lightweight Plan When
|
|
|
|
- one subsystem
|
|
- obvious change shape
|
|
- low risk
|
|
- easy to verify
|
|
|
|
## Use an Execution Plan When
|
|
|
|
- multiple subsystems or runtimes
|
|
- architectural tradeoffs matter
|
|
- staged verification is needed
|
|
- the work should be resumable by another agent or human
|
|
|
|
## Plan Location
|
|
|
|
- plans are task-scoped scratch artifacts; keep them with the work (worktree, branch, or PR description), not committed under `docs/`
|
|
- if a plan must be shared, keep names date-prefixed and task-specific
|
|
- delete plans once the work lands; do not leave mystery artifacts behind
|
|
|
|
## Plan Contents
|
|
|
|
- problem / goal
|
|
- non-goals
|
|
- file ownership or edit scope
|
|
- verification plan
|
|
- decisions made during execution
|