BonyanOSS Docs

Documentation site for BonyanOSS and the Bonyan-API.

Built with Mintlify. The docs are organized as a developer platform: ecosystem overview, project model, domain map, contribution guide, Bonyan-API docs, engineering guides, and API reference.

Run locally

pnpm install
pnpm dev

The site will be live at http://localhost:3000.

Useful scripts

Script	What it does
pnpm dev	Start the local dev server with hot reload.
pnpm build	Validate the documentation build.
pnpm broken-links	Crawl pages and report dead internal links.
pnpm openapi:check	Validate openapi.yaml against the OpenAPI spec.

Project layout

bonyan-docs/
├── docs.json
├── openapi.yaml
├── logo/
├── introduction.mdx
├── ecosystem.mdx
├── projects.mdx
├── domains.mdx
├── code-of-conduct.mdx
├── bonyan-api.mdx
├── quickstart.mdx
├── concepts/
├── guides/
└── api-reference/

Public URL plan

• Main site: bonyanoss.org
• Docs: docs.bonyanoss.org
• Status: status.bonyanoss.org
• Unified API: api.bonyanoss.org
• Bonyan API: api.bonyanoss.org/bonyan-api/v1
• Bonyan docs: docs.bonyanoss.org/bonyan-api

License

MIT © BonyanOSS.