OneDoc API Documentation

This repo contains the configuration files for the OneDoc's API documentation. The documentation is built using Fern.

Click here to see the generated website.

What does this repo contain?

• OpenAPI Specs
• Docs Configuration
• GitHub Workflows

How to update documentation?

To update your documentation, 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.