Generated references

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

The help texts and the API annotations are in the Rust code.

1 / 4

Never edit these files by hand

The script writes them again and your change goes away. To change them, see Change a reference page.

The four files

File	Source
`openapi/ferry.json`	`cargo run -p ferryd -- --dump-openapi`, with no change
`content/docs/reference/api/*`	fumadocs-openapi: one page per OpenAPI tag, plus `index.mdx` and `meta.json`
`content/docs/reference/cli.mdx`	`cargo run -p ferry-cli -- markdown-help` (clap-markdown)
`content/docs/reference/server-options.mdx`	`cargo run -p ferryd -- --dump-markdown-help`, plus the environment variables from `ferryd --help`

Code blocks

Each code block has a language. Options add a title, line numbers or a mark on a line.

Change a reference page

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