search

open-forest-observatory / geograypher

Multiview Semantic Reasoning with Geospatial Data
BSD 3-Clause "New" or "Revised" License
10 stars 4 forks source link

Improve high-level documentation #107

Open russelldj opened 2 months ago

russelldj commented 2 months ago

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

russelldj commented 2 months ago

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

russelldj commented 5 days 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 days ago

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