docs: clarify planning-workspace role + flesh README

This repo is the design-conversation space for the wiki-construct
project, not a deployed vault. The 403-line CLAUDE.md describes a
vault structure (flat per-domain, Content as a domain name) that
doesn't exist in this repo and was superseded by the actual live
implementation in ../wiki-vault/ (two-layer Sources+Wiki, Venture
instead of Content).

CLAUDE.md: prepended a header note framing this as the early draft
spec, pointing at wiki-vault/CLAUDE.md as canonical, and explaining
why the draft is kept (per wiki-construct-context.md's stated design-
history intent). The body of the spec is left unmodified below the
note — it's a frozen record.

README (new): explains the repo IS a planning workspace (not the
vault), maps each doc to its purpose, summarizes how the design
evolved from this draft to the live wiki-vault shape, points at
companion repos (wiki-vault, vault-mcp).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Travis Herbranson 2026-05-20 07:59:20 -04:00
parent 0f1347b362
commit 1435726f99
2 changed files with 95 additions and 1 deletions

View File

@ -1,4 +1,27 @@
# CLAUDE.md — HomeLab Wiki Vault Spec
# CLAUDE.md — HomeLab Wiki Vault Spec (draft, superseded)
> **Important context for agents:** this is the **wiki-context** repo,
> which is the **planning workspace** for the `wiki-construct` project,
> not a deployed vault. The vault structure described below is an
> **early design draft** that didn't survive contact with implementation
> — when the wiki was actually built, the structure became a two-layer
> `Sources/` + `Wiki/` split, and the `Content` domain was renamed to
> `Venture`.
>
> **Canonical implementation spec:**
> [`wiki-vault/CLAUDE.md`](../wiki-vault/CLAUDE.md). Read that one when
> you're operating on the live vault.
>
> **Why this draft is kept:** as `wiki-construct-context.md` explains,
> the planning conversation captured *why* decisions were made.
> Mutating this CLAUDE.md to match the live spec would erase that
> design history. Leave it as a frozen record of the design state at
> 2026-05-04; tracker is the live `wiki-vault/CLAUDE.md`.
>
> The rest of this file is the original draft, unmodified below this
> point.
---
This file is the spec for this Obsidian vault. Any agent operating
on this vault reads this file first to understand the structure,

View File

@ -0,0 +1,71 @@
# wiki-context
**Planning workspace** for the `wiki-construct` project — the design
conversation and decision history behind Travis's personal LLM-maintained
wiki. This repo holds the planning docs and the bundled
`wiki-maintenance` skill files, not the wiki itself.
The actual wiki lives in [`../wiki-vault/`](../wiki-vault). Operate on
the live vault there; come here to understand *why* it's shaped the way
it is.
## Layout
```
wiki-context/
├── CLAUDE.md # Early draft spec (frozen, superseded
│ # by wiki-vault/CLAUDE.md)
├── wiki-construct-project-plan.md # Project plan with locked decisions
├── wiki-construct-context.md # Design rationale + reasoning history
├── skill/
│ └── skill-wiki.md # Bundle for the wiki-maintenance skill
│ # (SKILL.md + compile.md + lint.md +
│ # migration.md, copy-paste-ready)
└── README.md # This file
```
## What's in each doc
| File | What it captures |
|------|------------------|
| `wiki-construct-context.md` | The *why* — the two converging conversations that produced the project, the wiki-vs-OB1 framing decision, why flat structure won, etc. The load-bearing context that future Claude sessions in this project space should read first. |
| `wiki-construct-project-plan.md` | The *what* — locked decisions, phases, tasks. Treated as a project plan, with frontmatter matching the wiki spec. |
| `CLAUDE.md` | Early draft of the wiki spec. **Frozen** as a design-history record. The vault that actually got built has a different shape — see `wiki-vault/CLAUDE.md` for the canonical current spec. |
| `skill/skill-wiki.md` | The contents of the `wiki-maintenance` skill bundle (4 files inside one for copy-paste deploy), used to populate `~/.claude/skills/wiki-maintenance/` on the host. |
## How the design evolved
The early CLAUDE.md drafted here proposed:
- A **flat** per-domain structure (`HomeLab/Dev/*.md` etc.)
- Four domains: Dev / **Content** / Homelab / Reference
What actually shipped in `wiki-vault/`:
- A **two-layer** structure: `Sources/` (raw inputs) + `Wiki/`
(compiled outputs)
- Four domains: Dev / **Venture** / Homelab / Reference (Content
renamed)
- Vault-mcp writes into `Sources/` via `create_artifact`;
the `wiki-maintenance` skill compiles into `Wiki/`
Both shapes are valid Karpathy-style LLM-wikis — the live one made
explicit what the draft left implicit (the Sources-vs-Wiki distinction).
## Companion repos
- [`wiki-vault/`](../wiki-vault) — the live vault; canonical spec
+ content.
- `homelab/vault-mcp/` — the MCP server that writes to the live vault
(dual-writes Postgres `petalbrain.wiki` + markdown). It also
embeds note content via Ollama into `petalbrain.public.embeddings`.
## Status
The project moved from this workspace into deployed reality in May 2026.
This repo is kept around as the design archive. Open it when you need
the rationale behind a vault decision; otherwise reach for `wiki-vault/`.
The leftover `main.py` / `pyproject.toml` / `uv.lock` / `.python-version`
files at the root are uv-init artifacts; they aren't part of this
workspace's purpose.