Docs Site Overview

This workspace documents all RitoSwap workspaces, including the docs site itself. It is built with Nextra 4 and branded to match the RitoVision feel.

Stack & structure

Concern	Implementation
Framework	Next.js (App Router) + Nextra 4
Content	MDX files under `docs/content`
UI components	Custom React components under `docs/app`
Theme config	`docs/theme.config.tsx`
MDX components	`docs/mdx-components.tsx`

- next.config.mjs
- theme.config.tsx
- package.json

Build & deploy

The docs site is deployed on Vercel and includes a Storybook build + sitemap generation in the pipeline.

pnpm dev runs the docs site locally.
pnpm build builds the Next.js app.
pnpm prebuild runs pnpm —filter ritoswap run build-sb:docs to publish Storybook into docs/public/storybook-static.
pnpm postbuild runs docs/scripts/generate-sitemap.mjs and pagefind for search.
pnpm test runs Vitest for docs-only tests.

Vercel deployment is configured in docs/vercel.json and uses pnpm build as the build command.

Branding source of truth

The docs theme and RitoVision styling are centralized in docs/styles/override.css. Other files exist in docs/styles, but override.css is the canonical source today.

Navigate this section

How interactive UI demos are embedded and built.

Storybook Playgrounds

Interactive Swagger UI for docs endpoints.

OpenAPI Playground

RitoVision typography, colors, and theme overrides.

Styling & Branding

Docs navigation system and drawer architecture.

Bottom Bar

Custom error UI and recovery flows.

Error Boundaries