SubMiner/docs/knowledge-base

Knowledge Base Rules

Status: active
Last verified: 2026-03-13
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 - agent-first operating principles
• Catalog - indexed docs and verification status
• Quality - 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.
• Record architectural quality drift in Quality.
• Keep stale docs obvious; do not leave ambiguity about whether a page is trustworthy.