mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-10-21 05:01:26 -07:00
# Conflicts: # launcher/main.test.ts # src/cli/help.test.ts # src/core/services/__tests__/stats-server.test.ts # src/core/services/cli-command.test.ts # src/core/services/tokenizer/yomitan-parser-runtime.test.ts # src/main/overlay-runtime.test.ts # src/main/runtime/character-dictionary-auto-sync.test.ts # src/main/runtime/cli-command-context-deps.test.ts # src/main/runtime/cli-command-context-factory.test.ts # src/main/runtime/cli-command-context-main-deps.test.ts # src/main/runtime/composers/cli-startup-composer.test.ts # src/main/runtime/stats-server-runtime.test.ts # src/main/runtime/tray-main-actions.test.ts # src/main/runtime/tray-main-deps.test.ts # src/main/runtime/tray-runtime-handlers.test.ts # src/main/runtime/tray-runtime.test.ts # src/main/runtime/yomitan-anki-server-sync.test.ts # src/preload.ts # src/renderer/handlers/mouse.test.ts # src/renderer/yomitan-popup.test.ts
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.