Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-04-10 01:16:39 +02:00
Code Issues Projects Releases Wiki Activity

meta: add note to generate openapi docs before starting local dev (#4976)

Browse Source 
This PR adds a small note to generate docs before running the docs
locally.
This commit is contained in:
Thomas Heartman 2023-10-16 14:49:42 +02:00 committed by GitHub
parent 24e5928ec9
commit 65d95e96df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/README.md
View File

@ -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
@ -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
```