search

open-forest-observatory / geograypher

Enabling Geospatial Predictions from Individual Drone Images
https://open-forest-observatory.github.io/geograypher/
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

Improve high-level documentation #107

Closed russelldj closed 4 months ago

russelldj commented 7 months ago

One option would be a user guide. Another would be a static site with function-level documentation, such as ReadTheDocs.

russelldj commented 7 months ago

Also look at: https://squidfunk.github.io/mkdocs-material/

russelldj commented 5 months ago

MkDocs is used in the OFO documentation site. The original comment about a separate user was silly, either ReadTheDocs or Mkdocs should support high-level documentation.

russelldj commented 5 months ago

If we go with mkdocs, we'd need to use this plugin to auto-generate the content.

russelldj commented 4 months ago

@asidhu0 has set up a stand-alone doc site at https://open-forest-observatory.github.io/geograypher/. Now we need to actually fill out some content there.

russelldj commented 4 months ago

Since @asidhu0 set up the site, I think it's on me to write some content.

russelldj commented 4 months ago

Closed with #137