From 770ba1d5235a48f986febe2c440290adc15b01a4 Mon Sep 17 00:00:00 2001
From: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
Date: Fri, 17 Sep 2021 05:06:09 -0700
Subject: [PATCH] fix: update the readme for the open api docs (#672)

---
 docs/README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/README.md b/docs/README.md
index 09d3a26bf..4f25a0efb 100644
--- 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.