From 65d95e96df74eec0d160c88a49ce04d0e471e178 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Mon, 16 Oct 2023 14:49:42 +0200 Subject: [PATCH] meta: add note to generate openapi docs before starting local dev (#4976) This PR adds a small note to generate docs before running the docs locally. --- website/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/README.md b/website/README.md index 7d8ca67f7593..6fffdc02117d 100644 --- a/website/README.md +++ b/website/README.md @@ -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 ```