Files
openyield/docs/shared/index.md
T
cloudinit-bot a780884379 docs(P01): complete docs foundation + firewall extension phase
P1 complete. Docs lexicon firewall (lexicon_meta_docs_test.go, 5 tests incl.
G-013 walk-coverage + G-014 shared self-test). MkDocs Material scaffold with
26-page nav (G-011). README.md + docs/index.md + 7 docs/shared/ pages. Both
firewalls green, go test ./... 22 packages green, no regression.

---ci---
project: oy
phase: 1
milestone: v0.3
status: complete
tag_base: v0.2.x
phase_role: execution
requirements:
  covered: [REQ-028]
  partial: [REQ-027]
---/ci---
2026-08-17 22:12:53 +00:00

902 B

Shared concepts

The Shared section holds the concepts common to every OpenYield audience — Nomads and Freeholders alike. These are the covenant-level ideas that make OpenYield a public-good mesh rather than a custodial platform.

  • Six Principles — the immutable covenant (REQ-001).
  • Bread Scale — the unit of value and its 11 tiers (REQ-013).
  • Storage Pools — the three pools (Stash, Vault, Root-Pool) (REQ-014).
  • Watchers & Mirror — the 9 Watchers, 6-of-9 quorum, the Mirror (REQ-004).
  • Lexicon — why 10 terms are banned, and what to say instead (REQ-012).
  • Vision — the OpenYield covenant in brief.

See the README for build instructions, or the Nomads and Freeholders sections for audience-specific docs.