2.0 KiB
2.0 KiB
Wiki Schema
Directory Structure
- sources/ — Document content. Short docs as .md, long docs as .json (per-page). Do not modify directly.
- sources/images/ — Extracted images from documents, referenced by sources.
- summaries/ — One per source document. Summary of key content.
- concepts/ — Cross-document topic synthesis. Created when a theme spans multiple documents.
- exercises/ — Student-facing exercise pages derived from course exercise sections; private solutions remain outside the wiki.
- explorations/ — Saved query results, analyses, and comparisons worth keeping.
- reports/ — Lint health check reports. Auto-generated.
Special Files
- index.md — Content catalog: every page with link, one-line summary, organized by category.
- log.md — Chronological append-only record of operations (ingests, queries, lints).
Page Types
- Summary Page (summaries/): Key content of a single source document.
- Concept Page (concepts/): Cross-document topic synthesis with wikilinks.
- Exercise Page (exercises/): Student-facing exercise text and metadata, without private solution code.
- Exploration Page (explorations/): Saved query results — analyses, comparisons, syntheses.
- Index Page (index.md): One-liner summary of every page in the wiki. Auto-maintained.
Index Page Format
index.md lists all documents, concepts, and explorations with metadata:
- Documents: name, one-liner description, type (short|pageindex), detail access path
- Concepts: name, one-liner description
- Exercises: exercise id, title, source section, and whether a private solution exists
- Explorations: name, one-liner description
Log Format
Each log entry: ## [YYYY-MM-DD HH:MM:SS] operation | description
Operations: ingest, query, lint
Format
- Use wikilink to link other wiki pages (e.g., concepts/attention)
- Standard Markdown heading hierarchy
- Keep each page focused on a single topic
- Do not include YAML frontmatter (---) in generated content; it is managed by code