Docs improvements (#117)

* remove mike for versioning and remove edit_uri

* use absolute link

* mention explorer

* newline

* add link for land cover

* remove mike

* fix changelog link in pyproject

README.md

@@ -75,3 +75,19 @@ severity                  moderate
 ```
 
 To see all of the available options, run `cyfi predict-point --help`.
+
+### A note on severity levels
+
+Severity levels are based on World Health Organization (WHO) cyanobacteria density thresholds.
+
+- Low: 0 - 20,000 cells/ml
+- Moderate: 20,000 - 100,000 cells/ml
+- High: > 100,000 cells/ml
+
+However users should feel free to to use their own thresholds as makes sense for their needs.
+
+### Visualizing predictions
+
+Launch the [CyFi Explorer](https://cyfi.drivendata.org/explorer/) to view the Sentinel-2 imagery used to generate each cyanobacteria estimate!
+
+![Screenshot of CyFi explorer showing the predictions table along with the Sentinel-2 imagery.](docs/docs/images/explorer_screenshot_2.jpg)

docs/docs/index.md

@@ -144,6 +144,10 @@ Severity levels are based on World Health Organization (WHO) cyanobacteria densi
 
 However users should feel free to to use their own thresholds as makes sense for their needs.
 
+### Visualizing predictions
+
+Launch the [CyFi Explorer](explorer.md) to view the Sentinel-2 imagery used to generate each cyanobacteria estimate!
+
 ------
 
 ## About the model
@@ -164,7 +168,7 @@ CyFi relies on two data sources as input:
 
 **Land cover map**
 
-* The Climate Research Data Package (CRDP) Land Cover Gridded Map (2020) classifies land surface into 22 classes, which have been defined using the United Nations Food and Agriculture Organization's Land Cover Classification System (LCCS). This map is based on data from the Medium Resolution Imaging Spectrometer (MERIS) sensor on board the polar-orbiting Envisat-1 environmental research satellite by the European Space Agency. This data comes from the CCI-LC database hosted by the ESA Climate Change Initiative's Land Cover project.
+* The Climate Research Data Package (CRDP) Land Cover Gridded Map (2020) classifies land surface into 22 classes, which have been defined using the United Nations Food and Agriculture Organization's Land Cover Classification System (LCCS). This map is based on data from the Medium Resolution Imaging Spectrometer (MERIS) sensor on board the polar-orbiting Envisat-1 environmental research satellite by the European Space Agency. This data comes from the CCI-LC database hosted by the [ESA Climate Change Initiative's Land Cover project](https://www.esa-landcover-cci.org/?q=node/164).
 
 ### Overview of the model
 

docs/mkdocs.yml

@@ -2,12 +2,13 @@ site_name: cyfi
 site_url: https://cyfi.drivendata.org/
 site_description: A python package to predict cyanobacteria density based on Sentinel-2 satellite imagery
 repo_url: https://github.com/drivendataorg/cyfi
+edit_uri: ""
 theme:
   name: flatly
 
 nav:
   - Installation: "installation.md"
-  - Quickstart: "./#quickstart"
+  - Quickstart: "index.md/#quickstart"
   - Visualize: "explorer.md"
   - Background: "about.md"
   - Changelog: "changelog.md"
@@ -17,10 +18,6 @@ markdown_extensions:
       permalink: True
       toc_depth: 3
 
-extra:
-  version:
-    provider: mike
-
 extra_css:
   - style.css
 

pyproject.toml

@@ -61,7 +61,6 @@ dev = [
   "black",
   "flake8",
   "jupyter",
-  "mike",
   "mkdocs",
   "mkdocs-bootswatch",
   "pytest",
@@ -73,7 +72,7 @@ dev = [
 "Repository" = "https://github.com/drivendataorg/cyfi"
 "Documentation" = "https://cyfi.drivendata.org/"
 "Bug Tracker" = "https://github.com/drivendataorg/cyfi/issues"
-"Changelog" = "https://cyfi.drivendata.org/stable/changelog/"
+"Changelog" = "https://cyfi.drivendata.org/changelog/"
 
 [tool.black]
 line-length = 99

requirements_docs.txt

@@ -1,3 +1,2 @@
-mike
 mkdocs
 mkdocs-bootswatch