Building uppy.io/docs VS uppy.io/blog (#243)

Co-authored-by: Antoine du Hamel <[email protected]>

Author: lakesare

README.md

@@ -1,13 +1,32 @@
 # Uppy.io
 
-Website and documentation for [uppy](https://uppy.io/).
+Website and documentation for [uppy.io](https://uppy.io).
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
-static website generator.
+Code for [uppy.io/blog](https://uppy.io/blog) lives in this repo.  
+Code for [uppy.io/docs](https://uppy.io/docs/quick-start) lives in
+[github.com/transloadit/uppy](https://github.com/transloadit/uppy).
 
 ## Developer guide
 
-### Installation
+If you want to edit [uppy.io/blog](https://uppy.io/blog), just edit the files in
+this repo.
+
+If you want to edit [uppy.io/docs](https://uppy.io/docs/quick-start), then you
+should:
+
+1. Clone both the **uppy** repo and **uppy.io** repo.
+
+2. Then, from your `uppy.io` clone, run:
+
+   ```sh
+   ln -s /path-to-your-uppy-repo/docs docs
+   ```
+
+   Now, treat **/uppy/docs** as your working directory, but run the build/lint
+   scripts from your **/uppy.io** directory - **/uppy.io** will pick up your
+   changes.
+
+### Install Dependencies
 
 ```sh
 corepack yarn
@@ -19,8 +38,17 @@ corepack yarn
 corepack yarn dev
 ```
 
-This command starts a local development server and opens up a browser window.
-Most changes are reflected live without having to restart the server.
+This command builds **/uppy/docs** and **/uppy.io**, and shows them in a
+browser. Most changes are reflected live without having to restart the server.
+
+### Lint
+
+```sh
+corepack yarn run format
+corepack yarn lint
+```
+
+This command lints **/uppy/docs** and **/uppy.io**.
 
 ### Build
 
@@ -30,3 +58,8 @@ corepack yarn build
 
 This command generates static content into the `build` directory and can be
 served using any static contents hosting service.
+
+---
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
+static website generator.