Description
What is your issue?
Our docs have a general issue with having lots of related resources that are not necessarily linked together in a useful way. This results in users (including myself!) getting "stuck" in one part of the docs and being unaware of material that would help them solve their specific issue.
To give a concrete example, if a user wants to know about coarsen
, there is relevant material:
- In the coarsen class docstring
- On the reshaping page
- On the computations page
- On the "how do I?" page
- On the tutorial repository
Different types of material are great, but only some of these resources are linked to others. Coarsen
is actually pretty well covered overall, but for other functions there might be no useful linking at all, or no examples in the docstrings.
The biggest missed opportunity here is the way all the great content on the tutorial.xarray.dev repository is not linked from anywhere on the main documentation site (I believe). To address that we could either (a) integrate the tutorial.xarray.dev
material into the main site or (b) add a lot more cross-linking between the two sites.
Identifying sections that could be linked and adding links would be a great task for new contributors.