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---
63 lines
2.3 KiB
YAML
63 lines
2.3 KiB
YAML
# OpenYield docs site (MkDocs Material, D-042).
|
|
#
|
|
# Build-only Python dep (mkdocs + mkdocs-material); NOT a Go dep (G-006 —
|
|
# go.mod stays zero-require). Invoke locally with `mkdocs serve` or
|
|
# `mkdocs build` (see README). No publishing CI in v0.3 (D-046 — publishing
|
|
# to GitHub/Gitea Pages deferred to v0.4).
|
|
#
|
|
# Nav completeness (G-011): the nav lists ALL 26 pages that will exist by end
|
|
# of P3. P1 creates the shared/ pages + index (8 files); P2 adds nomads/
|
|
# (8 files); P3 adds freeholders/ (8 files) + reference/ (2 files). Only the
|
|
# files that exist at P1 ship today; the nav references the not-yet-created
|
|
# P2/P3 pages by path so the structure is complete and P2/P3 just add files.
|
|
# mkdocs.yml is a config file, NOT validated by Go tests; the docs firewall
|
|
# (lexicon_meta_docs_test.go) validates .md content, not nav.
|
|
|
|
site_name: OpenYield
|
|
site_description: OpenYield — a jurisdiction-light, public-good mesh for real production, organized around Holders, Stands, and the Six Principles.
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- toc.integrate
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- toc:
|
|
permalink: true
|
|
- codehilite
|
|
- pymdownx.superfences
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Nomads:
|
|
- Overview: nomads/index.md
|
|
- Reach: nomads/reach.md
|
|
- Stash: nomads/stash.md
|
|
- Bearers: nomads/bearers.md
|
|
- Maps-Pay: nomads/maps-pay.md
|
|
- Pacts: nomads/pacts.md
|
|
- Standing: nomads/standing.md
|
|
- Window: nomads/window.md
|
|
- Freeholders:
|
|
- Overview: freeholders/index.md
|
|
- Signals: freeholders/signals.md
|
|
- Standing: freeholders/standing.md
|
|
- Stands & Guilds: freeholders/stands-guilds.md
|
|
- Councils & Voice: freeholders/councils-voice.md
|
|
- Bonds: freeholders/bonds.md
|
|
- Partner Spectrum: freeholders/partner-spectrum.md
|
|
- Anchor Preview: freeholders/anchor-preview.md
|
|
- Shared:
|
|
- Overview: shared/index.md
|
|
- Six Principles: shared/six-principles.md
|
|
- Bread Scale: shared/bread-scale.md
|
|
- Storage Pools: shared/storage-pools.md
|
|
- Watchers & Mirror: shared/watchers-mirror.md
|
|
- Lexicon: shared/lexicon.md
|
|
- Vision: shared/vision.md
|
|
- Reference:
|
|
- Architecture: reference/architecture.md
|
|
- Components: reference/components.md |