ATTENTION, WITH PROOF.Documentation benchmark
This documentation set was structured after reviewing mature product/protocol documentation and GitBook’s current Git Sync conventions on 2026-09-03.
References reviewed
- GitBook content configuration — repository-scoped root, landing page, and
SUMMARY.mdnavigation. - GitBook content structure — pages grouped into discoverable spaces/sections rather than one oversized document.
- OpenZeppelin Contracts documentation — progressive path from overview and concepts to security guidance and exact API reference.
- OpenZeppelin access-control guide — explicit privilege, admin, role, and operational-risk treatment.
- Safe Smart Account architecture — component architecture, trust assumptions, extension boundaries, and user-facing explanation.
- Safe contract reference — logically grouped public functions and events.
- Aave protocol introduction — plain-language user concepts before implementation details.
- Uniswap V2 core whitepaper — precise protocol mechanics and contract-level economic behavior.
Coverage adopted for Raidz
| Mature-doc pattern | Raidz implementation |
|---|---|
| Immediate orientation | Landing page, product overview, quickstart |
| Audience-specific paths | Creator, project, operator, and developer guides |
| Concepts before reference | Marketplace, Score, proof/settlement, token economics |
| Architecture and trust boundaries | System map, data placement, implementation gaps |
| Exact interfaces | HTTP API, contracts, database, proof schema |
| Security with operational consequences | Threat/control table, release gate, incident and observability pages |
| Version/current-status clarity | Component status matrix, dated boundary, roadmap gates |
| Publishable navigation | .gitbook.yaml, docs landing page, curated SUMMARY.md |
Deliberate Raidz additions
Because Raidz combines creator data and financial settlement, its docs explicitly distinguish live, implemented, specified, planned, and gated behavior. They also separate campaign funding from revenue, fixtures from real marketplace state, wallet identity signatures from transactions, and Pons integration pins from launch authorization.