cloudinit-bot
82ae6cf5a2
Milestone v0.3 complete. Feature type, tags v0.2.x. Two work-streams shipped under one feature milestone: (A) Bearers skeleton + tests (D-020 pattern, 7 x/* packages, zero ext deps): - x/bridge (NEW): BridgeStatus enum (4), BridgeRoute by-ID-string refs - x/exit (NEW): ExitStatus enum (5), ExitRoute, DEXSwap (opaque venue) - x/bearers (EXT): OYSATLink surveillance-resistant LOCKED, OYQRCode idempotent - x/partner (EXT): AnchorCredential (custody-provider-id empty in skeleton) - x/hub (NEW): HubService enum (3), LendingCouponCapBps=800 LOCAL const (A-304) - x/services (NEW): ServiceKind enum (4), window-id by-ID-string ref (A-307) - x/bond (EXT): GrowthBond, ClampGrowth G-012 underflow guard, secondary market All packages >=93.3% coverage. Both lexicon firewalls green. G-003 intact. (B) Documentation deliverable (REQ-027 complete, 26-page MkDocs Material site): - README.md + mkdocs.yml + docs/index.md - docs/shared/ (7 pages): Six Principles, Bread Scale, Storage Pools, Watchers/Mirror, Lexicon, Vision - docs/nomads/ (8 pages): Reach, Stash, Bearers, Maps-Pay, Pacts, Standing, Window - docs/freeholders/ (8 pages): Signals, Standing, Stands-Guilds, Councils-Voice, Bonds, Partner Spectrum, Anchor Preview - docs/reference/ (2 pages): Architecture, Components - REQ-028: lexicon firewall extended to docs/ + README.md (lexicon_meta_docs_test.go, 5 tests incl G-013 walk-coverage + G-014 shared self-test) Phases: P0 -> v0.2.0, P1 -> v0.2.1, P2 -> v0.2.2, P3 -> v0.2.3, P4 -> v0.2.4, P5 -> v0.2.5, P6 -> v0.2.6 (milestone release). Requirements covered: REQ-010, REQ-022, REQ-023, REQ-024, REQ-025, REQ-026 (skeleton), REQ-027, REQ-028 (complete). IDEATE-01..08 ratified and delivered. ---ci--- project: oy phase: 6 milestone: v0.3 status: complete tag_base: v0.2.x phase_role: final milestone_complete: true requirements: covered: [REQ-010, REQ-022, REQ-023, REQ-024, REQ-025, REQ-026, REQ-027, REQ-028] partial: [] ---/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. |