From eb0be31245e98543cf096a1a9b8ca99100db7a22 Mon Sep 17 00:00:00 2001
From: Aimee Ukasick <aimeeu.opensource@gmail.com>
Date: Fri, 23 Feb 2024 08:44:50 -0600
Subject: [PATCH] Docs: Update README with note about deploy preview link

Add a note about appending `docs/` to Netlify's generated deploy preview link so you can preview your changes.
---
 docs/README.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 821a63c25..8c19946a2 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -3,6 +3,9 @@
 This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
 That means, for installing and developing this docusaurus documentation, you will need to have node@16 or higher. 
 
+## Local development
+
+Execute these commands from the `/docs/` directory.
 
 ### Installation
 
@@ -10,7 +13,7 @@ That means, for installing and developing this docusaurus documentation, you wil
 $ yarn
 ```
 
-### Local Development
+### Local server
 
 ```
 $ yarn start
@@ -26,16 +29,21 @@ $ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
+## Pull request deploy preview
+
+Netlify generates a deploy preview URL. To see your changes, append `docs/` to the generated URL. 
 
-## Creating New Versions
+## Creating new versions
+
+### 1. Generate command docs
 
-### 1. Generate Command Docs
 ```bash
 cd ../ # main project directory
 go run -mod=vendor ./hack/gen-docs.go
 ```
 
-### 2. Create Version
+### 2. Create version
+
 ```bash
 yarn run docusaurus docs:version 0.1
 ```