← anatomy · cross-cutting rules · stubs
04 · CROSS-CUTTING RULES

Stubs.

status: stub · placeholder pages

A stub is a minimal page that exists for one reason only: so wiki-links never dangle. Every stub is tracked in the index so it doesn't get forgotten.

2026-03-14-checkout references [[payments-db]] payments-db status: stub owner: unknown Stub. Referenced by [[2026-03-14-checkout]]. tracked in index.md under Stubs to flesh out

Just enough to satisfy a wiki-link. Real content arrives on a later ingest.

A stub, in full

wiki/services/payments-db.mdspecimen · the entire file
---
type:          service
name:          payments-db
status:        stub
owner:         unknown
sources:       []
source_hashes: {}
tags:          []
last_updated:  2026-04-26
---

Stub. Referenced by [[2026-03-14-checkout]]. Not yet documented.

Lifecycle

  1. An ingest creates a wiki-link to an entity that doesn't yet have a page.
  2. That ingest creates the stub: frontmatter with status: stub + one sentence pointing at what referenced it.
  3. The stub is added to index.md under Stubs to flesh out — with the referring page so it doesn't get forgotten.
  4. A later ingest (with a real source) upgrades status: stub to status: draft and writes the actual page.
  5. The next index refresh removes the entry from Stubs to flesh out.

Rules

  1. Every stub has status: stub in its frontmatter — that's the marker the index uses.
  2. Body is exactly one sentence: "Stub. Referenced by [[…]]. Not yet documented."
  3. sources is [] and source_hashes is {} — there's nothing to hash yet.
  4. Every stub appears in index.md under Stubs to flesh out, with its referrer.
  5. Never leave a dangling wiki-link. If you can't write the full page now, write the stub.