https://github.com/onedoclabs/fileforge-docs

Fern Configuration for FileForge
https://github.com/onedoclabs/fileforge-docs

Last synced: 7 days ago
JSON representation

Fern Configuration for FileForge

• Host: GitHub
• URL: https://github.com/onedoclabs/fileforge-docs
• Owner: OnedocLabs
• Created: 2024-04-08T22:23:17.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T00:04:44.000Z (16 days ago)
• Last Synced: 2024-10-28T04:12:03.621Z (16 days ago)
• Language: MDX
• Homepage:
• Size: 2.29 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OneDoc API Documentation

This repo contains the configuration files for the OneDoc's API documentation. 

The documentation is built using Fern. 

Click [here](https://fileforge.docs.buildwithfern.com) to see the generated website. 

## What does this repo contain?

- [OpenAPI Specs](./fern/openapi.yml)

- [Docs Configuration](./fern/docs.yml)

- [GitHub Workflows](./.github/workflows)

## How to update documentation?

To update your documentation, run 

```sh

# npm install -g fern-api 

fern generate --docs

```

To preview your documentation, run 

```sh

# 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.