1.9 KiB
1.9 KiB
viexp — Knowledge Index
This folder is the project's Obsidian vault: all long-lived knowledge about viexp lives here,
in English. The Obsidian app config (.obsidian/) is gitignored; the notes themselves are part
of the repository.
Entry points
- roadmap — the master plan: 20-hour learning sprints (Josh Kaufman, "First 20 Hours")
- workflows/research-workflow — how we collect and analyze research artifacts
- workflows/gitea-workflow — how the board, labels, milestones and issues are organized
- workflows/english-workflow — how the project doubles as English practice
- workflows/session-workflow — the two ritual prompts that open and close every practice session
Folders
| Folder | Contents | Template |
|---|---|---|
research/ |
Raw research notes: one question per note | TMP/Research.md |
articles/ |
Polished syntheses, comparisons, guides | TMP/Article.md |
decisions/ |
Architecture Decision Records (ADRs) | TMP/Decision.md |
sprints/ |
One plan+retro note per 20-hour sprint | TMP/Sprint.md |
tasks/ |
Task notes (mirrored as Gitea issues) | TMP/Task.md |
devlog/ |
Daily practice journal | TMP/DevLog.md |
learning/ |
Glossary, error journal, cheat sheets | TMP/ErrorJournal.md, TMP/Glossary.md |
attachments/ |
Images and other research artifacts | — |
TMP/ |
Obsidian templates (vault root) | — |
Conventions
- Note titles in
kebab-caseEnglish; frontmattertype/statusis required (used for filtering). - Headings are stable across notes of one type, so Obsidian folding always works the same way.
- Every decision must trace back to at least one
research/note; every task to a decision or the roadmap. - New templates live in
TMP/(Obsidian: Settings → Templates → folder =TMP).