Documentation site
The Fumadocs site in website/ compiles Markdown and MDX files in
docs/ directly. Edit those files to update both GitHub documentation and the site.
docs/meta.json and directory meta.json files control sidebar order and groups. Review reports stay outside the site navigation.
Run locally
Use Node.js 24 and pnpm 11.25.0. Python 3 serves the local static preview.
cd website
pnpm install --frozen-lockfile
pnpm dev --hostname 127.0.0.1 --port 4300Open http://127.0.0.1:4300/docs/. The site includes navigation, full-text search,
code highlighting and a table of contents. Light mode is the default; the theme switch also offers dark mode.
Check and build
pnpm lint
pnpm types:check
pnpm build
pnpm test
pnpm startBuild output
The build copies benchmark reports and example configuration from docs/ into the static export. Generated assets and Next.js output stay outside version control. The site is a separate package from the Python CLI.
The default social preview uses website/app/opengraph-image.png and its
opengraph-image.alt.txt description.
Site tests
pnpm test checks the exported pages, links, search, Markdown downloads, and 404s over controller loopback. It does not contact workspace hosts.
Set RAFT_DOCS_TEST_PORT if port 4391 is occupied.
Machine-readable documentation
/llms.txtlists the Markdown files for every documentation page./llms-full.txtexports the complete documentation./llms.mdx/docs/contract/content.mdexports the contract as Markdown.
GitHub Pages serves fixed files. Use the explicit Markdown URLs; documentation
pages return HTML regardless of the Accept header.
Hosting
The public site is raft.micr.dev. GitHub Pages serves
website/out/ at the domain root. Search runs in the browser using a build-time index.
- Pull requests build and test the site. Pushes to
maindeploy the verified export. - Set the repository Pages publishing source to GitHub Actions.
- For a fork, replace
website/public/CNAMEand themetadataBaseURL inwebsite/app/layout.tsxwith your domain, then configure Pages and DNS.
For a local production preview, pnpm start serves the same export at
http://127.0.0.1:4300/. Any static HTTP host can serve the exported files.
Publishing the documentation does not provide public
ingress to Raft workspaces.
Typography
| Element | Font |
|---|---|
| Page titles | Funnel Display |
| Body text | Inter |
| Code blocks | Monospace |
The pairing follows boat.dev. Upright Latin WOFF2 files from Fontsource live in website/public/fonts/; their SIL Open Font Licenses are in boat-fonts-license.txt.
next/font/local serves the bundled fonts without third-party requests.
Light mode uses Boat's white background, dark text, and thin borders. The theme switch also offers dark mode.