This repository contains your Fern Configuration:

• SDK generator config

npm install -g fern-api

To validate your API, run:

fern check

To run a local development server with hot-reloading you can run the following command

fern docs dev

To update your documentation on a hosted URL, run

# npm install -g fern-api
fern generate --docs

To preview your documentation, run

# npm install -g fern-api
fern generate --docs --preview

The repository contains GitHub workflows that will automatically run these commands for you. For example, when you make a PR a preview link will be auto-generated and when you merge to main the docs site will update.

To deploy your SDKs, simply run the Release <sdk-language> SDK GitHub Action with the desired version for the release. Under the hood, this leverages the Fern CLI:

fern generate --group <sdk-language>

You can also regenerate the SDKs locally by running:

fern generate --group <sdk-language> --preview --log-level debug