mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-20 12:11:28 -07:00
docs: add stats dashboard design docs, plans, and knowledge base
- Stats dashboard redesign design and implementation plans - Episode detail and Anki card link design - Internal knowledge base restructure - Backlog tasks for testing, verification, and occurrence tracking
This commit is contained in:
30
docs/workflow/README.md
Normal file
30
docs/workflow/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
<!-- read_when: starting implementation, deciding whether to plan, or checking handoff expectations -->
|
||||
|
||||
# Workflow
|
||||
|
||||
Status: active
|
||||
Last verified: 2026-03-13
|
||||
Owner: Kyle Yasuda
|
||||
Read when: planning or executing nontrivial work in this repo
|
||||
|
||||
This section is the internal workflow map for contributors and agents.
|
||||
|
||||
## Read Next
|
||||
|
||||
- [Planning](./planning.md) - when to write a lightweight plan vs a full execution plan
|
||||
- [Verification](./verification.md) - maintained test/build lanes and handoff gate
|
||||
- [Release Guide](../RELEASING.md) - tagged release workflow
|
||||
|
||||
## Default Flow
|
||||
|
||||
1. Read the smallest relevant docs from `docs/`.
|
||||
2. Decide whether the work needs a written plan.
|
||||
3. Implement in small, reviewable edits.
|
||||
4. Run the cheapest sufficient verification lane.
|
||||
5. Escalate to the full maintained gate before handoff when the change is substantial.
|
||||
|
||||
## Boundaries
|
||||
|
||||
- Internal process lives in `docs/`.
|
||||
- Public/product docs live in `docs-site/`.
|
||||
- Generated artifacts are never edited by hand.
|
||||
Reference in New Issue
Block a user