From 5753faf9de79d6ac6d8831630a88424545c88350 Mon Sep 17 00:00:00 2001
From: SEHI L'YI <sehilyi@gmail.com>
Date: Sun, 30 Jun 2024 19:03:57 -0400
Subject: [PATCH] Update README.md

---
 README.md | 42 +++++++++++++++---------------------------
 1 file changed, 15 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 1853068..a8fd269 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,20 @@
-# A Documentation Website for Gosling.js
+# A Documentation Website for Gosling
 
-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+This is a repository for the official documentation of the Gosling project. The documentation is hosted at http://gosling-lang.org.
 
-
-## Installation
+## Development
 
 ```sh
 yarn install
-```
-
-## Local Development
-
-
-```sh
 yarn start
 ```
 
-The above command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+The above commands will install all dependencies, start a local development server, and open a web browser. Most changes will be reflected live without having to restart the server.
 
+This website uses `assets/gosling.schema.json` to generate property tables.
+You can run the following command if you want to update the property tables based on the updated Gosling schema in your local copy of `gosling-lang/gosling.js`.
+This assumes your local copies of `gosling-lang/gosling-website` and `gosling-lang/gosling.js` are in the same directory.
 
-Gosling uses `assets/gosling.schema.json` to generate property tables.  
-If you have a local `gosling.js` repo and want to update the gosling.schema from that repo.  
-Assuming your `gosling-website` and `gosling.js` repos are in the same directory, you can run
 ```
 cd assets
 . copy.sh
@@ -37,15 +30,9 @@ The above command generates static content into the `build` directory and can be
 
 ## Deployment
 
-<!-- ```console
-GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. -->
+The Gosling-Website is deployed to AWS S3 BUCKET `http://gosling-lang.org` using [this GitHub Workflow](https://github.com/gosling-lang/gosling-website/blob/main/.github/workflows/deploy_action.yml).
 
-The Gosling-Website is deployed to AWS S3 BUCKET `gosling-lang.org` using [this github action](https://github.com/gosling-lang/gosling-website/blob/main/.github/workflows/deploy_action.yml).
-
-The deployment is trigger when a push is made to the main branch.
+The deployment is triggered when a push is made to the main branch.
 
 ## Versioning
 ```
@@ -68,13 +55,14 @@ website
 
 ```
 
-We will edit the ./docs whenever we make changes to gosling.js.
-When we are sure that the current docs (`/docs`) is ready to be frozen (typically when we bump a major gosling.js version), run the script below
+We edit any documents under `./docs` whenever we make changes to gosling.js.
+When we are sure that the current docs (`/docs`) is ready to be deployed (typically, when we bump a minor version of gosling.js), the following script should be run:
+
 ```
 yarn run tag_version x.x.x
 ```
 
-This command will:
-- Copy the full `./docs` folder contents into a new `versioned_docs/version-<x.x.x>` folder.
-- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as `versioned_sidebars/version-<x.x.x>-sidebars.json`.
+This command:
+- Copy the full `./docs` folder contents into a new `versioned_docs/version-<x.x.x>` folder;
+- Create a versioned sidebars file based on your current sidebar configuration, if exists, such as `versioned_sidebars/version-<x.x.x>-sidebars.json`; and
 - Append the new version number to `versions.json`.