docs: bootstrap vault, roadmap and research

This commit is contained in:
2026-10-17 21:14:19 +03:00
parent 749afadcd4
commit 8fa0632d69
34 changed files with 1508 additions and 0 deletions
+27
View File
@@ -0,0 +1,27 @@
---
type: article
status: draft
created: {{date}}
updated: {{date}}
tags: [article]
sources: []
---
# {{title}}
> **TL;DR** — one or two sentences: what the reader should learn from this article.
## Introduction
Why this article exists and who it is for.
## Main part
### Section
## Conclusions
## Sources
-
---
*This article doubles as English writing practice: prefer short, simple sentences; add new vocabulary to the glossary.*
+28
View File
@@ -0,0 +1,28 @@
---
type: decision
adr:
status: proposed
date: {{date}}
supersedes:
tags: [adr]
---
# {{title}}
## Context
The problem or force that makes this decision necessary.
## Options considered
| Option | Pros | Cons |
|--------|------|------|
| | | |
## Decision
What we chose and why — one paragraph, no hedging.
## Consequences
- Positive:
- Negative / risks:
- Mitigations:
<!-- status: proposed → accepted → superseded by a newer ADR (set `supersedes` on the new one) -->
+25
View File
@@ -0,0 +1,25 @@
---
type: devlog
date: {{date}}
sprint:
minutes:
tags: [devlog]
---
# Dev log — {{date}}
## What I did
-
## Code review notes
Reviewer feedback and what I changed because of it.
## Rust notes
New syntax, borrow-checker battles (→ ErrorJournal), aha-moments.
## English practice
New words and phrases I used today:
- *word / phrase* — перевод, my own example sentence
## Next session
-
+21
View File
@@ -0,0 +1,21 @@
---
type: error
created: {{date}}
tags: [error-journal, rust]
---
# {{title}}
## The error
```text
paste the exact compiler / runtime error here
```
## What I expected
## What actually caused it
## The fix
## Self-correction cue
One-line rule to recognize and fix this error class next time on my own.
+11
View File
@@ -0,0 +1,11 @@
---
type: glossary
created: {{date}}
tags: [glossary, english]
---
# {{title}}
| Term / phrase | Translation | Where I met it | My example sentence |
| ------------- | ----------- | -------------- | ------------------- |
| | | | |
+29
View File
@@ -0,0 +1,29 @@
---
type: research
status: inbox
confidence: low
created: {{date}}
question:
tags: [research]
---
# {{title}}
## Research question
What exactly do we need to learn, and why does it matter for viexp?
## Sources
| # | Source | Kind | Freshness | Key takeaway |
|---|--------|------|-----------|--------------|
| 1 | | docs / code / issue / reddit / blog | | |
## Findings
-
## Open questions
- [ ]
## Outcome
Which decisions, tasks or articles came out of this research (link them).
<!-- status: inbox → in-progress → analyzed → archived · confidence: low → medium → high -->
+43
View File
@@ -0,0 +1,43 @@
---
type: sprint
number:
status: planned
started:
finished:
hours-planned: 20
hours-logged: 0
tags: [sprint]
---
# Sprint {{title}}
## Theme
One line: the single sub-skill + app feature this sprint is about.
## App deliverable
The concrete, demoable thing that must exist at the end of the sprint.
## Rust focus — the vital 20%
Syntax and concepts to practice, each mapped to real app code.
## Practice drills (20–30 min each)
- [ ] Drill 1
- [ ] Drill 2
- [ ] Drill 3
## English focus
What and how we practice this sprint (README section, commit messages, article…).
## Session rhythm (45 min)
5 min — review yesterday's log and errors → 30 min — focused practice → 10 min — DevLog + ErrorJournal.
## Definition of done
- [ ] Deliverable works
- [ ] `cargo test` green
- [ ] clippy clean
- [ ] Retro filled in below
## Retrospective
### Shipped
### Frustrations (link ErrorJournal entries)
### Hours logged / English notes
+27
View File
@@ -0,0 +1,27 @@
---
type: task
status: todo
priority: P2
sprint:
gitea-issue:
created: {{date}}
due:
tags: [task]
---
# {{title}}
## Goal
One sentence describing what must exist when this task is done.
## Acceptance criteria
- [ ] Criterion 1
- [ ] Criterion 2
## Notes
Context, links to research notes and decisions, sketches.
## Log
- {{date}} — task created.
<!-- status: todo | in-progress | blocked | review | done | cancelled · priority: P0 urgent … P3 nice-to-have -->