Change a reference page

To change a generated page, change the Rust side. Then run the generator and commit the result.

Change Rust. The text of the reference pages is in the Rust code.

1 / 4

Do these steps after you change a command, a flag, an API handler or a DTO.

To change	Edit
The text of the CLI and server pages	The clap help of `ferry` and `ferryd`
The text of the API pages	The `#[utoipa::path]` annotations of utoipa and the doc comments of the schemas, in `ferry-api` and `ferry-core`
How the script makes the pages	`scripts/generate.mjs`

Terminal

cd docs
npm run generate         # runs cargo in the repository root

Terminal

npm run generate:check   # CI: exits 1 when a committed file is stale

The generated files are in git. Thus npm run build works without Rust.

Generated references

Four reference files come from the Rust code. A script writes them, thus they always agree with the code.

Build and deploy

npm run build writes the static site to out/ and fails on a broken link.