Skip to content

Latest commit

 

History

History

fern

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

OctoAI Documentation 🐙

This is the source of the OctoAI's public facing documentation found at octo.ai/docs. These docs utilize .mdx files with the Fern service/framework.

Run Locally 🏃‍♂️

NOTE: node is required for local development of these docs, if you do not have node on your system refer to the NodeJS documentation.

Clone the project using

# via URL
git clone https://github.com/octoml/fern-config.git

# via SSH
git clone git@github.com:octoml/fern-config.git

Go to the project directory

  cd fern-config/fern/docs

Globally install the Fern CLI

npm i -g fern-api

Generate docs

fern generate --docs

Test publish docs action

fern generate --docs --preview

Development

It is highly recommended to use the MDX VSCode Extension if using the VSCode IDE.

The docs.yml file is the core configuration file where you can specify various settings and properties to customize your documentation. These settings include structure, API configurations, integrations, analytics, redirects, and search engine optimization.

For writing content, the Fern Docs break down the MDX standards required.

There are also Components provided by Fern that can be used to add interactivity and styling to the docs. Those can be found here.

OpenAPI

OpenAPI documentation is autogenerated from the parsed OpenAPI spec. See Fern Docs for details.

All OpenAPI specs are in the ./fern/apis directory.

The docs generated by the specs are held in the .fern/docs/api-reference directory.

Deployment 🖥️

Merging to main will kick off an automatic deployment to production.