Skip to content

Commit

Permalink
meta: add note to generate openapi docs before starting local dev (#4976
Browse files Browse the repository at this point in the history
)

This PR adds a small note to generate docs before running the docs
locally.
  • Loading branch information
thomasheartman authored Oct 16, 2023
1 parent 24e5928 commit 65d95e9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
yarn install
```

## Generate Open API docs
## Generate OpenAPI docs

```console
yarn generate
Expand All @@ -18,6 +18,8 @@ Generate the Open API docs that live at Reference documentation > APIs > OpenAPI

## Local Development

Before running the docs the first time, you'll need to generate external documentation, as described in the [generate OpenAPI docs](#generate-openapi-docs) section.

```console
yarn start
```
Expand Down

0 comments on commit 65d95e9

Please sign in to comment.