mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-05-26 00:55:16 -07:00

Files

T

docs: audit and refresh user-facing and internal docs

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/.

2026-05-23 21:21:16 -07:00

1.6 KiB

Raw Blame History

Verification

Status: active
Last verified: 2026-05-23
Owner: Kyle Yasuda
Read when: selecting the right verification lane for a change

Default Handoff Gate

bun run typecheck
bun run test:fast
bun run test:env
bun run build
bun run test:smoke:dist

If docs-site/ changed, also run:

bun run docs:test
bun run docs:build

Cheap-First Lane Selection

Docs-only boundary/content changes: bun run docs:test, bun run docs:build
Internal KB / AGENTS.md changes: bun run test:docs:kb
Config/schema/defaults: bun run test:config, then bun run generate:config-example if template/defaults changed
Launcher/plugin: bun run test:launcher or bun run test:env
Runtime-compat / compiled behavior: bun run test:runtime:compat
Coverage for the maintained source lane: bun run test:coverage:src
Deep/local full gate: default handoff gate above

Coverage Reporting

bun run test:coverage:src runs the maintained test:src lane through a sharded coverage runner: one Bun coverage process per test file, then merged LCOV output.
Machine-readable output lands at coverage/test-src/lcov.info.
CI and release quality-gate runs upload that LCOV file as the coverage-test-src artifact.

Rules

Capture exact failing command and error when verification breaks.
Prefer the cheapest sufficient lane first.
Escalate when the change crosses boundaries or touches release-sensitive behavior.
Never hand-edit dist/launcher/subminer; validate it through build/test flow instead.

1.6 KiB Raw Blame History