Skip to content

Repository files navigation

Ensuro OKF Documentation Bundle

This repository is the Open Knowledge Format (OKF) v0.1 documentation bundle for the Ensuro protocol — a blockchain-based, regulated reinsurance protocol.

Structure

├── index.md                  Bundle root (landing page)
├── README.md                 This file
├── AGENTS.md                 AI-agent instructions
├── log.md                    Change log
├── docmd.config.json         docmd static site configuration
├── package.json              Node dependencies
├── .github/workflows/deploy.yml  GitHub Pages deploy workflow
├── scripts/
│   └── check_okf.py          OKF conformance checker
├── assets/
│   ├── images/               Diagrams and logos
│   └── openapi/              OpenAPI specs
├── protocol/                 General protocol FAQ and concepts
├── liquidity-providers/      LP documentation
├── risk-partners/            Risk partner documentation
├── deployments/              Smart contract addresses
├── smart-contracts/          Architecture and contract reference
├── offchain-apis/            REST API documentation
├── frontend/                 Frontend security and monitoring
└── legal/                    Legal and compliance documents

Local Development

npm install
npm run dev       # Start dev server at http://localhost:3000
npm run build     # Build static site to ./site/

Conformance

python3 scripts/check_okf.py

Validates OKF frontmatter, internal links, and asset references.

Migration

This bundle was migrated from the GitBook site ensuro/docs (archived). See log.md for details and known gaps.

About

Ensuro protocol documentation bundle (OKF v0.1) — rendered with docmd

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages