mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-05-29 12:55:16 -07:00
sudacode
791c993870
- Convert flat prose entries in CHANGELOG.md and docs-site/changelog.md to bold headers + sub-bullets - Scope artifact uploads in release/prerelease workflows to `latest*.yml` instead of `*.yml` - Update release-notes and RELEASING docs to match - Adjust workflow tests for new nested bullet format
SubMiner Internal Docs
Status: active
Last verified: 2026-05-23
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
Fast Paths
- New feature or refactor: Workflow, then Architecture
- Test/build/release work: Verification, then Release Guide
- Coverage lane selection or LCOV artifact path: Verification
- “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.