FerryDocs
Contributing

Docs site

This site is a project of its own in docs/. The build changes MDX pages into a static site.

Edit on GitHub
generateRust codehelp, OpenAPIMDX pagescontent/docs/npm run buildNext.js, Fumadocsdocs/out/a static site

You write the pages as MDX files in content/docs/.

1 / 3

This site is in docs/. It is a project of its own, like the dashboard in web/.

It uses on 16 (App Router, React 19, TypeScript strict, Tailwind CSS v4). The build makes a in docs/out/.

Start the dev server

Terminal
cd docs
npm install
npm run dev                    # → http://localhost:3000

In this section

Write a pageThe short version of the rules of AUTHORING.md.FiguresDiagram, Flow, Terminal, Mermaid and Term.Generated referencesThe pages that come from the Rust code.Build and deployThe static export and the link check.

What the browser stores

The session is a cookie that the page cannot read. localStorage has only the preferences of the UI.

Run the site on your machine

Three commands start the dev server of the docs. Each change of a page shows in the browser.

On this page

Start the dev serverIn this section