Update odc-stac documentation to be more accessible to users #49
Description
This ticket is about beginning the process of updating our documentation, and understanding how we might start to tackle it. The goal is to complete a select number of minor updates to the odc-stac read the docs to understand how we want to communicate information. This can then be developed into a set of principles we can take forward into updating other documentation.
To complete this card, we should
- Review the Diataxis framework for documentation
- First pass of how elements of the current docs map to the framework
- From the above list, design one tutorial, one how-to-guide, one explanation, and one reference example to work on
- Complete tutorial example. Note any learnings
- Complete how-to-guide example. Note any learnings
- Complete explanation example. Note any learnings
- Complete reference example. Note any learnings
- Promote improvements to documentation and ask for feedback
- Identify next set of ideas for improvement