Files
pom-omp/docs/BOUNDARY.md

3.0 KiB

title, description
title description
Repository Wiki vs Generated Project Vault Clear boundary between extension documentation and project knowledge bases

Repository Wiki vs Generated Project Vault

These are two entirely separate documentation systems. Confusing them is a primary source of drift.

Repository Wiki (this site)

Property Value
Purpose Documents the POM 2 extension for operators, contributors, architects
Source /home/loca/dev/omppmo/docs/, /home/loca/dev/omppmo/README.md, /home/loca/dev/omppmo/POM.yml, /home/loca/dev/omppmo/skills/pom/references/
Audience Humans installing, developing, or auditing the extension
Build Quartz 5 (npm run serve:dev in this repo)
Deploy target pom-omp.loca.zone (or similar)
Content type Static extension documentation: install, commands, architecture, contracts, release process

Generated Project Vault

Property Value
Purpose Knowledge projection for a specific creative project produced by POM stages
Source Created at runtime by src/persistence.ts:226-239 (bootstrapProject) under the project root
Audience The author/editor working on that specific creative work
Build Quartz 5 (separate instance per project, configured by config/config.yml template)
Deploy target Project-specific domain (e.g., my-novel.loca.zone)
Content type Dynamic creative artifacts: canon, cast, timeline, manuscript, research, images

Boundary rules

  1. Repository wiki NEVER contains project-specific content — no canon, no cast, no manuscript scenes
  2. Generated vault NEVER contains extension documentation — no install instructions, no command maps, no tool schemas
  3. README.md's content/ tree (lines 80-98) describes the vault shape, not this wiki — do not mistake the example vault structure for this repository's documentation
  4. POM.yml's knowledge.vault field describes the generated vault format — Obsidian-flavoured Markdown compatible with Quartz 5, but each project gets its own Quartz config

Navigation consequence

  • This wiki has an "Operator → Generated Vault" link that explains the vault shape and points to src/persistence.ts as the owner
  • A generated vault has a "Meta → Extension docs" link pointing back to this wiki's URL
  • They are separate Quartz instances with separate quartz.config.ts, separate deployments, separate domains

Common confusion points

Confusion Reality
"Where is the wiki for my novel?" In your project's content/, deployed to your project's domain
"Why doesn't docs/ have my story bible?" docs/ is the extension wiki; your story bible is in 02_story_bible/
"Can I edit the extension docs from my project?" No — edit /home/loca/dev/omppmo/docs/ and rebuild the extension wiki
"Does pom vault modify this wiki?" No — pom vault inserts a mention into the generated project's production board