enhancing documentation

terraref / documentation

TERRAref documentation

https://docs.terraref.org

6 stars 7 forks source link

Closed ghost closed 4 years ago

ghost commented 7 years ago

This is very dense. How can we simplify it? If we reduce the content, there will be less for people to complain about. For example, maps of the experimental design would be nice but really?
We need to make sure that the rest of the team is contributing.

dlebauer commented 7 years ago

We could also split it into different books or sections.

If we compile the documentation using the gitbook cli, we can have different SUMMARY.md files that compile different subsets.

We could have different books, e.g. for

Science objectives and data access
- science objectives
- data formats / web interfaces
- tutorials / examples
Data transfer and computing pipeline
- including algorithms, software
- how to add / development section

Just an idea ... what do others think?