mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-05-26 12: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/.
30 lines
1.7 KiB
Markdown
30 lines
1.7 KiB
Markdown
<!-- read_when: you need to know what internal docs exist, whether they are current, or what should be updated -->
|
|
|
|
# Documentation Catalog
|
|
|
|
Status: active
|
|
Last verified: 2026-05-23
|
|
Owner: Kyle Yasuda
|
|
Read when: finding internal docs or checking verification status
|
|
|
|
| Area | Path | Status | Last verified | Notes |
|
|
| --- | --- | --- | --- | --- |
|
|
| KB home | `docs/README.md` | active | 2026-05-23 | internal entrypoint |
|
|
| Architecture index | `docs/architecture/README.md` | active | 2026-05-23 | top-level runtime map |
|
|
| Domain ownership | `docs/architecture/domains.md` | active | 2026-05-23 | runtime and feature ownership |
|
|
| Layering rules | `docs/architecture/layering.md` | active | 2026-05-23 | dependency direction and smells |
|
|
| KB rules | `docs/knowledge-base/README.md` | active | 2026-05-23 | maintenance policy |
|
|
| Core beliefs | `docs/knowledge-base/core-beliefs.md` | active | 2026-03-13 | agent-first principles |
|
|
| Quality scorecard | `docs/knowledge-base/quality.md` | active | 2026-03-13 | quality grades and gaps |
|
|
| Workflow index | `docs/workflow/README.md` | active | 2026-05-23 | execution map |
|
|
| Planning guide | `docs/workflow/planning.md` | active | 2026-05-23 | lightweight vs execution plans |
|
|
| Agent plugins | `docs/workflow/agent-plugins.md` | active | 2026-05-23 | repo-local agent workflow plugin ownership |
|
|
| Verification guide | `docs/workflow/verification.md` | active | 2026-05-23 | maintained verification lanes |
|
|
| Release guide | `docs/RELEASING.md` | active | 2026-05-23 | release checklist |
|
|
|
|
## Update Rules
|
|
|
|
- Add a row when introducing a new core internal doc.
|
|
- Update `Status` and `Last verified` when a page is materially revised.
|
|
- If a page is known inaccurate, mark it stale immediately instead of leaving silent drift.
|