dask / dask/community

Documentation Refresh

Open
#170 14 comments 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
25
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Dask has a tremendous amount of well-written documentation, but I am not sure if it is presented effectively (if anyone has any insight on this I'd love to get some data about it). These are some ideas that I am thinking about:

- Fewer pages in the left-nav. I have been seeing other projects make a clearer split between **For Users** and **For Developers/Contributors** I feel like that's a tough split for Dask since there is so much overlap and lots of users end up extending or needing to know about the internals for some other reason. I think that these could be grouped into a page called **Internals** and a lot of the pages that are in **Help and Reference** and **Diagnostics** could be moved into that section.
- Include the new figures from https://github.com/dask/community/issues/135 and make them clickable.
- Use top nav section more effectively. Since that piece is consistent across subprojects, it should consistently point to the most globally useful places.
- Use the right space better. The xarray docs put page level TOC at the right of the page. That feels like a nice improvement to me.
- Make one API Reference rather than separating out Array, Dataframe ... right now there is a lot of duplication between https://docs.dask.org/en/latest/dataframe-api.html#create-dataframes and https://docs.dask.org/en/latest/dataframe-create.html
- Not to pick on dask.dataframe too much, but this TOC is really hard to navigate
![image](https://user-images.githubusercontent.com/4806877/125675760-8cab1e1c-410c-4dda-9354-99a4011fe3ce.png) I think it could be improved by removing the section headers from the TOC or somehow moving them up.

I am particularly motivated by the xarray doc refresh. I think their theme looks very nice as well, but I'll save that for another time...

## Current docs
[![image](https://user-images.githubusercontent.com/4806877/125655617-e47c29e2-fafc-4419-9f80-12b003053094.png)](https://docs.dask.org/en/latest/)

## Xarray
[![image](https://user-images.githubusercontent.com/4806877/125652238-a9471739-4699-4bfb-a4f5-4640ba005a5f.png)](http://xarray.pydata.org/en/stable/)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.