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/.
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
<!-- read_when: starting substantial work in this repo or looking for the internal source of truth -->
|
|
|
|
# SubMiner Internal Docs
|
|
|
|
Status: active
|
|
Last verified: 2026-05-23
|
|
Owner: Kyle Yasuda
|
|
Read when: you need internal architecture, workflow, verification, or release guidance
|
|
|
|
`docs/` is the internal system of record for agent and contributor knowledge. Start here, then drill into the smallest doc that fits the task.
|
|
|
|
## Start Here
|
|
|
|
- [Architecture](./architecture/README.md) - runtime map, domains, layering rules
|
|
- [Workflow](./workflow/README.md) - planning, execution, verification expectations
|
|
- [Knowledge Base](./knowledge-base/README.md) - how docs are structured, maintained, and audited
|
|
- [Release Guide](./RELEASING.md) - tagged release checklist
|
|
|
|
## Fast Paths
|
|
|
|
- New feature or refactor: [Workflow](./workflow/README.md), then [Architecture](./architecture/README.md)
|
|
- Test/build/release work: [Verification](./workflow/verification.md), then [Release Guide](./RELEASING.md)
|
|
- Coverage lane selection or LCOV artifact path: [Verification](./workflow/verification.md)
|
|
- “What owns this behavior?”: [Domains](./architecture/domains.md)
|
|
- “Can these modules depend on each other?”: [Layering](./architecture/layering.md)
|
|
- “What doc should exist for this?”: [Catalog](./knowledge-base/catalog.md)
|
|
|
|
## Rules
|
|
|
|
- Treat `docs/` as canonical for internal guidance.
|
|
- Treat `docs-site/` as user-facing/public docs.
|
|
- Keep `AGENTS.md` short; deep detail belongs here.
|
|
- Update docs when behavior, architecture, or workflow meaningfully changes.
|