Updated instructions

README.md

@@ -2,8 +2,6 @@
 
 ![Build Pages](https://github.com/DataONEorg/api-documentation/workflows/Build%20Pages/badge.svg)
 
-[![Documentation Status](https://readthedocs.org/projects/dataone-architecture-documentation/badge/?version=latest)](https://dataone-architecture-documentation.readthedocs.io/en/latest/?badge=latest)
-
 API and Architecture documentation for DataONE.
 
 This is a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) 
@@ -15,15 +13,15 @@ The current released version of the documentation is available at:
 
   https://purl.dataone.org/architecture
 
-The draft version built from GitHub sources is available at:
+Or:
 
-  https://dataone-architecture-documentation.readthedocs.io/en/latest/
+  https://dataoneorg.github.io/api-documentation/
 
 
 ## Contributing
 
 These documents are built automatically after the GitHub repository is updated
-with a commit.
+with a push to master. See the [GitHub Action work flow](https://github.com/DataONEorg/api-documentation/blob/master/.github/workflows/gh-pages.yml) for more details
 
 Minor edits can be made through the GitHub editor interface or through
 the usual clone / fork, edit, commit, and push / pull-request process.
@@ -37,16 +35,22 @@ various sphinx `auto*` directives.
 
 ## Building
 
-1. Ensure that the various requirements are installed:
+This project uses [Poetry](https://python-poetry.org/docs/) for dependency management. 
+
+```
+git clone https://github.com/DataONEorg/api-documentation.git
+cd api-documentation
+poetry install
+make html
+```
 
-* [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
-* [recommonmark](https://recommonmark.readthedocs.io/en/latest/)
-* [plantweb](https://plantweb.readthedocs.io/)
-* [sqltable](https://github.com/datadavev/docutils_sqltable) *Note:* this module is to be deprecated.
+The generated HTML will be available at `build/html/index.html`
 
-2. Clone or fork the repository
+Live generation and reload is also available:
 
-3. Change to the folder of the checked-out project
+```
+make livehtml
+```
 
-4. Run `make clean html` to generate HTML documentation
+A local web server will make the pages available at http://localhost:8000/ and edits to the source will be automatically rendered in the browser.