mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-20 12:11:28 -07:00
sudacode
20f53c0b70
- Load persisted known-word cache on startup; reconcile adds/deletes/edits on timed sync - Add `knownWords.addMinedWordsImmediately` (default `true`) for immediate mined-word updates - Route full rebuild to explicit `subminer doctor --refresh-known-words` and expand tests/docs
SubMiner Internal Docs
Status: active
Last verified: 2026-03-13
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 - runtime map, domains, layering rules
- Workflow - planning, execution, verification expectations
- Knowledge Base - how docs are structured, maintained, and audited
- Release Guide - tagged release checklist
- Plans - active design and implementation artifacts
Fast Paths
- New feature or refactor: Workflow, then Architecture
- Test/build/release work: Verification, then Release Guide
- “What owns this behavior?”: Domains
- “Can these modules depend on each other?”: Layering
- “What doc should exist for this?”: Catalog
Rules
- Treat
docs/as canonical for internal guidance. - Treat
docs-site/as user-facing/public docs. - Keep
AGENTS.mdshort; deep detail belongs here. - Update docs when behavior, architecture, or workflow meaningfully changes.