Files
pom-omp/docs/VAULT.md

4.0 KiB
Raw Blame History

title, description
title description
Generated Project Vault Shape The canonical directory structure and content types created by bootstrapProject

Generated Project Vault Shape

Created by src/persistence.ts:226-239 (bootstrapProject). This is the project knowledge base, not the extension wiki.

Top-level directories

<project-root>/
├── 00_admin/                 # Canonical state, manifests, ledgers, checksums
│   ├── project_state.json    # Active POM state (source of truth)
│   ├── artifact_manifest.json
│   ├── artifact_events.jsonl
│   ├── SHA256SUMS.txt
│   ├── validation/           # Gate reports (stage-N-scope-stamp.json)
│   ├── hive/                 # Hive mission records
│   └── swarms/               # Optional Swarm DAG definitions
├── 01_planning/              # Stage 0-3 outputs
│   ├── brief.md
│   ├── genre.md
│   ├── voice.md
│   └── story_store.md
├── 02_story_bible/           # Stage 4 outputs
│   ├── canon.md
│   ├── cast.md
│   ├── world.md
│   ├── timeline.md
│   ├── continuity.md
│   └── visual_bible/
├── 03_manuscript/            # Stage 5-7 outputs
│   ├── outline.md
│   ├── scenes/
│   └── chapters/
├── 04_images/                # Visual assets
│   ├── references/
│   ├── generated/
│   ├── briefs/
│   └── approvals/
├── 05_research/              # Source notes and rights
│   ├── sources.md
│   ├── notes.md
│   ├── fact_invention.md
│   └── rights.md
├── 06_ledgers/               # Decisions, revisions, continuity, quality, validation
│   ├── decisions.jsonl
│   ├── assumptions.jsonl
│   ├── revisions.jsonl
│   ├── continuity.jsonl
│   ├── quality.jsonl
│   └── validation.jsonl
├── 07_exports/               # Checkpoint and final archives
│   ├── <slug>-checkpoint-<stamp>.zip
│   ├── <slug>-final-<stamp>.zip
│   └── <base>.verification.json
├── content/                  # Obsidian/Quartz knowledge projection
│   ├── index.md
│   ├── canon/
│   ├── cast/
│   ├── timeline/
│   ├── manuscript/
│   └── research/
└── .omp/                     # Host and POM project configuration
    ├── config.yml            # OMP host settings (theme, task concurrency, etc.)
    ├── pom.json              # POM project settings
    └── prompts/              # Project-local prompt overrides

Vault content conventions

Directory Format Purpose
content/ Markdown + YAML frontmatter + wikilinks Human-navigable knowledge projection
00_admin/ JSON/JSONL Machine-readable canonical state and evidence
01_planning05_research Markdown Author-facing creative artifacts
06_ledgers JSONL Append-only decision/revision/continuity logs
07_exports ZIP + JSON Verified delivery archives with sidecars
.omp/ YAML/JSON Project-scoped configuration

Quartz compatibility

  • content/ is a valid Quartz 5 content vault
  • Frontmatter uses title, tags, aliases, date, modified
  • Wikilinks use [[page]] and [[page|alias]] syntax
  • Callouts use > [!note], > [!warning], > [!important]
  • Maps of content via dataview or manual index pages
  • quartz.config.ts for the project is generated from config/config.yml template

Source of truth hierarchy

  1. Project filesystem (00_admin/project_state.json, artifact files, ledgers)
  2. content/ vault (navigable projection, derived from #1)
  3. OMP session state (append-only, never canonical)
  4. Memory (Mnemopi) — ephemeral, never canonical

Regeneration

The vault is not regenerated from source on every change. It is incrementally updated by src/persistence.ts when artifacts are registered or state changes. To fully rebuild: rm -rf content && /pom vault (re-projects from canonical state).