Files
SubMiner/docs/workflow/README.md
T
sudacode c02edc90cc 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.1 KiB

Workflow

Status: active
Last verified: 2026-05-23
Owner: Kyle Yasuda
Read when: planning or executing nontrivial work in this repo

This section is the internal workflow map for contributors and agents.

  • Planning - when to write a lightweight plan vs a full execution plan
  • Verification - maintained test/build lanes and handoff gate
  • Agent Plugins - repo-local plugin ownership for agent workflow skills
  • Release Guide - tagged release workflow

Default Flow

  1. Read the smallest relevant docs from docs/.
  2. Decide whether the work needs a written plan.
  3. Implement in small, reviewable edits.
  4. Run the cheapest sufficient verification lane.
  5. Escalate to the full maintained gate before handoff when the change is substantial.

Boundaries

  • Internal process lives in docs/.
  • Public/product docs live in docs-site/.
  • Generated artifacts are never edited by hand.