Ryu Docs

The documentation site for Ryu — 200+ pages plus hundreds of generated API-reference pages, live at ryuhq.com/docs.

A Next.js + Fumadocs app: the deep "state of everything" reference for Ryu, organized into 13 sidebar realms and kept honest with file citations.

Read-only mirror. This repo is generated from the Ryu monorepo — see Contributing before opening a PR.

Stack

• Next.js (App Router) + fumadocs-ui / fumadocs-core / fumadocs-mdx
• fumadocs-openapi for the interactive API playground
• Tailwind CSS, mermaid diagrams

Install / Build

bun install
bun run dev            # next dev on port 4000
bun run generate:docs  # regenerate API-reference pages from specs/
bun run build          # generate:docs + next build

Container: docker build -t ryu-docs . && docker run -p 3002:3002 ryu-docs.

What it provides

• 13 sidebar realms: Start Here, Desktop, CLI, Mobile, Hardware, Gateway, Core, Security, Develop, Benchmark, Skills, MCP Server, Cookbook, and Academy — defined by root: true meta.json files.
• Interactive OpenAPI reference (content/docs/develop/api-reference/): rendered by fumadocs-openapi with a live request playground.
• Two source specs (specs/): gateway-openapi.yaml (hand-authored) and core-openapi.json (generated from Core's Axum handlers via utoipa, e.g. ryu-core --dump-openapi).
• Regeneration: bun run generate:docs (scripts/generate-docs.ts) rebuilds the API-reference pages from the specs.

Contributing

Content and code changes land in the Ryu monorepo and are mirrored here; this repo is not the source of truth, and direct pushes are overwritten on the next mirror run. PRs opened here are ported back to the mono by the maintainers, so they are welcome — see CONTRIBUTING.md and STYLE_GUIDE.md for the docs voice and page conventions.

License

Apache-2.0. See LICENSE. © 2026 A Major Pte. Ltd.