docs: karpathy-pattern wiki built from the spec, plan, design contract and decisions ledger
kb/ is its own wiki root: 34 pages across 7 categories, index.md catalog, log.md, AGENTS.md schema layer, and raw/ holding copies of README, the spec, the 13-task plan, the design master and the SDD ledger. Every page cross-references 3 to 6 others and all 107 wikilinks resolve except two [["list"]] artefacts inside JSON snippets in the copied plan. Kept separate from the repository root on purpose: its generated graph lands in kb/.ua/ instead of overwriting the code graph. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.7
parent
735a57bfd6
commit
8b42a0931c
@@ -0,0 +1,26 @@
|
||||
# Wiki conventions (schema layer)
|
||||
|
||||
This directory is a Karpathy-pattern wiki: raw sources, wiki pages, and this schema file.
|
||||
|
||||
## Layout
|
||||
- `raw/` — immutable sources copied from the repository. Never edited here.
|
||||
- `index.md` — the catalog, grouped by category. Every page appears exactly once.
|
||||
- `log.md` — chronological record of what was added, and why.
|
||||
- `<Page Name>.md` — one page per concept. File name is the link target.
|
||||
|
||||
## Categories
|
||||
- Pipeline
|
||||
- Data and storage
|
||||
- Security and credentials
|
||||
- Interface
|
||||
- Verification
|
||||
- Operations
|
||||
- Decisions
|
||||
|
||||
## Page rules
|
||||
1. Start with `# <Page Name>`, then 120 to 250 words of prose.
|
||||
2. Cross-reference with `[[Page Name]]`. Every page links 3 to 6 others, and every link must resolve.
|
||||
3. State measured facts (numbers, timings, error strings) instead of adjectives. Note the measurement when it
|
||||
came from a specific artifact.
|
||||
4. A page about a decision says: what the old behaviour was, what it cost, what replaced it, what it broke.
|
||||
5. No code blocks longer than 5 lines. Long code belongs in `raw/`.
|
||||
Reference in New Issue
Block a user