Files
SubMiner/docs
sudacode 36181d8dfc docs: address second round of spec review feedback
Add isCacheFull() method to controller interface for prefetcher
stopping condition, specify pause flag mechanism for live priority,
and clarify replaceChildren() applies to all subtitle root clears.
2026-03-15 12:22:00 -07:00
..

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

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.