Docs v1 continued

README.md

@@ -6,8 +6,6 @@
 
 An open source AI model and interface for Earth.
 
-# Getting started
-
 ## Quickstart
 
 Launch into a [JupyterLab](https://jupyterlab.readthedocs.io) environment on
@@ -74,3 +72,26 @@ To train the model:
 
 More options can be found using `python trainer.py fit --help`, or at the
 [LightningCLI docs](https://lightning.ai/docs/pytorch/2.1.0/cli/lightning_cli.html).
+
+## Contributing
+
+### Writing documentation
+
+Our Documentation uses [Jupyter Book](https://jupyterbook.org/intro.html).
+
+Install it with:
+```bash
+pip install -U jupyter-book
+```
+
+Then build it with:
+```bash
+jupyter-book build docs/
+```
+
+You can preview the site locally with:
+```bash
+python -m http.server --directory _build/html
+```
+
+There is a GitHub Action on `./github/workflows/deploy-docs.yml` that builds the site and pushes it to GitHub Pages.

docs/_toc.yml

@@ -7,25 +7,25 @@ parts:
 - caption: Release notes
   chapters:
     - title: Software release notes
-      file: changelog
+      file: release-notes/changelog
     - title: Model release notes
-      file: specification
+      file: release-notes/specification
     - title: Data sampling strategy
-      file: data_sampling
+      file: release-notes/data_sampling
 - caption: Getting Started
   chapters:
     - title: Installation
-      file: installation
+      file: getting-started/installation
     - title: Basic Use
-      file: basic_use
+      file: getting-started/basic_use
 - caption: Tutorials
   chapters:
     - title: Clay v1 wall-to-wall example
-      file: clay-v1-wall-to-wall
+      file: tutorials/clay-v1-wall-to-wall
     - title: Explore embeddings from Clay Encoder
-      file: visualize-embeddings
+      file: tutorials/visualize-embeddings
     - title: Clay MAE reconstruction
-      file: reconstruction
+      file: tutorials/reconstruction
 - caption: About Clay
   chapters:
     - title: GitHub