Skip to content

Commit 02a42cd

Browse files
authored
add info on contributing to docs
1 parent 74231d7 commit 02a42cd

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# VAPI API Documentation
22

3-
This repository contains the source files for the documentation found at [docs.vapi.ai](https://docs.vapi.ai/). You can suggest edits by making a pull request.
3+
This repository contains the source files for the documentation found at [docs.vapi.ai](https://docs.vapi.ai/).
4+
5+
## How can I contribute to these docs?
6+
7+
You can suggest edits by making a pull request.
8+
9+
## How to update documentation?
10+
11+
### Local Development server
12+
13+
To run a local development server with hot-reloading you can run the following command
14+
15+
```sh
16+
fern docs dev
17+
```
18+
19+
#### Hosted URL
20+
21+
To update your documentation on a hosted URL, run
22+
```
23+
# npm install -g fern-api
24+
fern generate --docs
25+
```
26+
To preview your documentation, run
27+
```
28+
# npm install -g fern-api
29+
fern generate --docs --preview
30+
```
31+
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.

0 commit comments

Comments
 (0)