SubMiner/docs/README.md

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.md short; deep detail belongs here.
• Update docs when behavior, architecture, or workflow meaningfully changes.