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/.
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
<!-- read_when: changing internal docs structure, adding guidance, or debugging doc drift -->
|
|
|
|
# Knowledge Base Rules
|
|
|
|
Status: active
|
|
Last verified: 2026-05-23
|
|
Owner: Kyle Yasuda
|
|
Read when: maintaining the internal doc system itself
|
|
|
|
This section defines how the internal knowledge base is organized and maintained.
|
|
|
|
## Read Next
|
|
|
|
- [Core Beliefs](./core-beliefs.md) - agent-first operating principles
|
|
- [Catalog](./catalog.md) - indexed docs and verification status
|
|
- [Quality](./quality.md) - current doc and architecture quality grades
|
|
|
|
## Policy
|
|
|
|
- `AGENTS.md` is an entrypoint only.
|
|
- `docs/` is the internal system of record.
|
|
- `docs-site/` is user-facing; do not treat it as canonical internal design or workflow storage.
|
|
- Internal docs should be short, cross-linked, and specific.
|
|
- Every core internal doc should include:
|
|
- `Status`
|
|
- `Last verified`
|
|
- `Owner`
|
|
- `Read when`
|
|
|
|
## Maintenance
|
|
|
|
- Update the relevant internal doc when behavior or workflow changes.
|
|
- Add new docs to the [Catalog](./catalog.md).
|
|
- Record architectural quality drift in [Quality](./quality.md).
|
|
- Keep stale docs obvious; do not leave ambiguity about whether a page is trustworthy.
|