Update the docs and website README (#154)

Author: oscarpolanco

docs/README.md

@@ -0,0 +1,31 @@
+# Clay Documentation
+
+On this directory, we have the pre-release documentation written using markdown. This file has the `.md` extension and as we mentioned before, these are pre-release files if you don't add a documentation version yet.
+
+## Markdown options
+
+These files have the following structure at the beginning of the file:
+
+```
+---
+id: idOftheFile
+title: Title of your file
+sidebar_label: Title of the sidebar
+---
+
+My new content here..
+```
+
+The previous example has a couple of the most important part to identify the content that you wish to add to your documentation. Here is a more detailed explanation on the [Markdown feature](https://docusaurus.io/docs/en/doc-markdown) that you can use.
+
+## Test documentation page
+
+We have a local server that we use to test your current docs content. Here are the steps on how to set the [local server](https://github.com/clay/claycli/tree/master/website#run-the-local-server). Normally you will have access on your browser with a url like this:
+
+`http://localhost:3000/claycli/docs/idOfTheDocs`
+
+But if you already have a [version](https://github.com/clay/claycli/tree/master/website#versioning-the-code) on your docs you will need to add `next` on your url
+
+`http://localhost:3000/claycli/docs/next/idOfTheDocs`
+
+[Here](https://docusaurus.io/docs/en/versioning) are more insights about what to do when you already have documentation with version.

website/README.md

@@ -1,4 +1,4 @@
-You will need to to have `Node >= 8.x` and `Yarn >= 1.5`.
+You will need to have `Node >= 8.x` and `Yarn >= 1.5`.
 
 # Run the local server
 
@@ -7,7 +7,9 @@ You will need to to have `Node >= 8.x` and `Yarn >= 1.5`.
 ```sh
 $ yarn
 ```
+
 or
+
 ```sh
 $ npm install
 ```
@@ -17,7 +19,9 @@ $ npm install
 ```sh
 $ yarn start
 ```
+
 or
+
 ```sh
 $ npm run start
 ```
@@ -27,41 +31,89 @@ $ npm run start
 Your project file structure should look something like this
 
 ```
-my-docusaurus/
-  docs/
-    cli.md
+root-directory
+  ├── docs
+    ├── docs.md
   website/
-    blog/
-    core/
-    node_modules/
-    pages/
-    static/
-      css/
-      img/
-    versioned_docs/
-    versioned_sidebars/
-    README.md
-    package.json
-    sidebar.json
-    siteConfig.js
-    versions.json
+    ├── README.md
+    ├── core
+      └── Footer.js
+    ├── i18n
+      └── en.json
+    ├── package.json
+    ├── pages
+      └── en
+        └── index.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+      ├── css
+        └── custom.css
+      └── img
+        ├── favicon
+        └── logo.svg
+    └── versioned_docs
+      └── version 0.0.0
+        ├── docs.md
+    └── versioned_sidebars
+      ├── version-0.0.0-sidebars.json
 ```
 
-# Publish the website
-The Claycli website will live on GitHub page. You just need to run the following commands:
+# Versioning the Code
+
+The first step to begin the process of versioning your documentation is to generate the `versions` script on your website directory with the following command.
+
+```sh
+yarn examples versions
 ```
-$ yarn build
+
+or
+
+```sh
+npm run examples versions
+```
+
+Then, you proceed to create a version of the docs that you need. In this case, it needs to match the version of your current `package.json`. To do this we will use the following command followed by the version number that you want.
+
+```sh
+$ yarn version X.X.X
 ```
+
 or
+
+```sh
+$ npm version X.X.X
 ```
-$ npm run build
+
+This will create all the files needed to handle the version that you just built, but this will be necessary only in 2 cases:
+
+1. If the documentation doesn't have a version set
+2. If there is a major update on the number of the version
+
+For other cases, we have an active call [update version](https://github.com/clay/claycli/blob/master/.github/main.workflow) that will handle the change of the version automatically.
+
+# Publish the website
+
+This process is automatically done by an action call [Build and push docs](https://github.com/clay/claycli/blob/master/.github/main.workflow) but you can deploy your documentation manually. You just need to run the following commands:
+
+```sh
+$ yarn build
 ```
 
-Then you just need to deploy the static files generated. These files will be pushed to the `gh-page` branch.
+or
+
+```sh
+$ npm run build
 ```
+
+Then, deploy the static files generated. These files will be pushed to the `gh-page` branch.
+
+```sh
 $ yarn deploy
 ```
+
 or
-```
+
+```sh
 $ npm run deploy
 ```