Merge pull request #715 from nextstrain/docs

Docs

.gitignore

@@ -8,10 +8,6 @@ s3/
 /local_narratives/
 /narratives/
 
-## docs
-build/
-i18n/
-
 ### OSX ###
 .DS_Store
 

docs-src/.gitignore

@@ -0,0 +1,3 @@
+## docs
+build/
+i18n/

docs-src/README.md

@@ -1,27 +1,39 @@
 # Auspice Documentation
 
 This folder contains the static site generator and the markdown files which form the auspice documentation website.
-This is currently designed to be served from github pages.
+This is currently designed to be served from GitHub pages using the `auspice/docs` folder.
 [Docusaurus](https://docusaurus.io/) is used to generate the static site.
 
-### Folder structure:
+### Folder structure of `auspice/docs-src/`
 * `README.md` this file
-* `docs/` contains the raw markdown files. The filenames (and directory names) will be used as URLS.
+* `docs/` contains the raw markdown files. The filenames (and directory names) will be used as URLs.
+New pages here should also be added to `sidebars.json`.
 * `website/` the files needed to build the website.
-  * `website/sidebars.json` define the doc links in the sidebar
-  * `website/pages/index.js` the splash page
+  * `./sidebars.json` define the doc links in the sidebar
+  * `./pages/index.js` the splash page
+  * `./siteConfig.js` docusarus configuration - [see docs here](https://docusaurus.io/docs/en/site-config)
 
-### How to develop:
+
+## How to run 
+
+All commands run from this directory (`docs-src`).
+
+#### Installing dependencies
 ```bash
-cd website
-npx docusaurus-start
+npm install
 ```
 
-### How to deploy:
+#### Developing (live reloading etc):
+```bash
+npm run develop
+```
+
+#### (re-)build the static site
 
 ```bash
-cd website
-npx docusaurus-build # creates website/build/*
-cd ..
-cp -r website/build/auspice/* ../docs
+npm run build
 ```
+> This command will modify the files in `../docs/` which is where the GitHub pages site is served from.
+
+#### Deploy
+Once changes are merged into the master branch and pushed to GitHub the changes will be live.