fix: update the readme for the open api docs (#672)

paritytech · Sep 17, 2021 · 770ba1d · 770ba1d
1 parent f4556ae
commit 770ba1d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,9 @@
 # Sidecar OpenApi UI
 
-Proposed OpenApi spec for [substrate-api-sidecar](https://github.com/paritytech/substrate-api-sidecar) v1.
+OpenApi spec for [substrate-api-sidecar](https://github.com/paritytech/substrate-api-sidecar).
+
+## Contributing:
+
+After updating the docs, ensure to run `yarn build:docs` from the root directory of this repository.
+
+This will make sure that the `dist` is updated with the current changes. Please verify the changes made work with an editor such as [swagger](https://editor.swagger.io/) by copying the `src/openapi-v1.yaml` file and pasting into the editor.