Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Deep linking" disparate documentation resources together #8008

Open
TomNicholas opened this issue Jul 19, 2023 · 3 comments
Open

"Deep linking" disparate documentation resources together #8008

TomNicholas opened this issue Jul 19, 2023 · 3 comments

Comments

@TomNicholas
Copy link
Member

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:

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.

@JessicaS11
Copy link
Contributor

JessicaS11 commented Oct 11, 2023

Another concrete example that came up at today's office hours (#8220) was content related to apply_ufunc (thanks @amanbagrecha!).

@amanbagrecha
Copy link
Contributor

Thanks @JessicaS11 for tagging me to this issue. I think this would be a good issue for me to pick up. Can you assign it to me @TomNicholas? I'd try to cross-link as many docs apart from what is mentioned here

@TomNicholas
Copy link
Member Author

Hi @amanbagrecha ! We don't normally assign issues, but you're welcome to work on this! Feel free to tag me for reviews or if you have any questions 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants