https://github.com/deepgram/deepgram-docs
Deepgram's docs site
https://github.com/deepgram/deepgram-docs
developer-documentation
Last synced: 5 months ago
JSON representation
Deepgram's docs site
- Host: GitHub
- URL: https://github.com/deepgram/deepgram-docs
- Owner: deepgram
- License: isc
- Created: 2024-11-06T23:31:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-24T14:38:58.000Z (8 months ago)
- Last Synced: 2025-06-24T15:24:31.517Z (8 months ago)
- Topics: developer-documentation
- Language: MDX
- Homepage: https://docs.deepgram.com
- Size: 36.1 MB
- Stars: 3
- Watchers: 10
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Deepgram's Docs
This repo contains the architecture for Deepgram's docs and SDK generation.
Our docs site and SDKs are built with [Fern](http://buildwithfern.com).
## Prerequisites
- Node.js v18+
- Fern CLI
### Installing the Fern CLI
The Fern CLI is used to develop, validate, and generate the docs and SDKs.
```shell
npm install -g fern-api
```
Optionally, if you want to publish preview URLs or the hosted docs, you'll need to authenticate with Fern.
```shell
fern login
```
## Validating your API specs
To validate your API specs, run:
```shell
fern check
```
## Updating your SDKs
To update your SDKs, run:
```shell
fern generate --group java-sdk
```
## Updating your Docs
### Local Development server
To run a local development server with hot-reloading you can run the following commands:
```shell
# Run the local development server
fern docs dev
```
### Preview URLs
To generate a shareable but un-indexed staging link, you can run the following command:
```shell
fern generate --docs --preview
```
### Viewing Custom Components or API Playground Changes
To view custom components or API Playground changes in a Preview URL, you can run the following commands:
```shell
# Generate the docs preview
fern generate --docs --preview
```
### Production Docs
Documentation is automatically published when you run the `fern generate` command. We only expect this to be ran via the GitHub Actions workflows.
Please **_DO NOT RUN THIS COMMAND MANUALLY_** unless you know what you're doing.
```sh
fern generate --docs
```
## Contributing
To contribute to the Docs, you can create a new branch, make your changes, and then create a pull request. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.