cloudinit-bot
a780884379
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---
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# OpenYield
|
|
|
|
OpenYield is a jurisdiction-light, public-good mesh for **real production**. It
|
|
runs on OY Chain (Layer 1), a canonical state layer for the Bread unit, the
|
|
Storage Pools, Standing, Watcher attestations, and the Pact / Council /
|
|
Partner surface. The mesh is anti-greed by construction: Mission Lock fixes
|
|
the Six Principles and fee covenant so no council can amend them, and the
|
|
coupon cap on bonds is a mission-locked ceiling, not a parameter.
|
|
|
|
## Audiences
|
|
|
|
The docs are organized by audience:
|
|
|
|
- **Nomads** — the everyday Holder: your Reach, your Stash, your bearers, how
|
|
you pay (Maps-Pay), the Pacts you join, and the Window you open. See
|
|
[Nomads](nomads/index.md).
|
|
- **Freeholders** — the active participant: the four signals, Bayesian
|
|
Standing, Stands & Guilds, the three Councils and Voice, the bond market,
|
|
and the four-tier Partner Spectrum. See [Freeholders](freeholders/index.md).
|
|
- **Shared** — concepts common to every audience: the Six Principles, the
|
|
Bread scale, the three Storage Pools, the Watchers & Mirror, the lexicon
|
|
glossary, and the vision overview. See [Shared](shared/index.md).
|
|
- **Reference** — the architecture and component map. See
|
|
[Reference](reference/architecture.md).
|
|
|
|
## Build the docs
|
|
|
|
This site is [MkDocs Material](https://squidfunk.github.io/mkdocs-material/),
|
|
a build-only Python dep (not a Go dep). To preview locally, see the
|
|
[README](../README.md) for build instructions. |