search

LM-SAL / aiapy

Python library for AIA data analysis
https://aiapy.readthedocs.io/en/stable/
BSD 3-Clause "New" or "Revised" License
7 stars 3 forks source link

Rethink structure of our docs #102

Closed nabobalis closed 11 months ago

nabobalis commented 3 years ago

In GitLab by @wtbarnes on Jul 26, 2021, 18:31

Currently, the documentation landing page is not terribly user-friendly. There is a lot of text and it takes a few clicks to get to the example gallery, arguably the most useful portion of the documentation. We should think a bit more carefully about how the documentation is laid out and how best to structure it to be as user-friendly as possible.

See these two related issues on the SunPy repo:

This issue should serve as a point of discussion for how best to reorganize things

nabobalis commented 3 years ago

In GitLab by @derosaml on Jul 27, 2021, 12:21

Are you are referring to this page? https://aiapy.readthedocs.io/en/stable/

nabobalis commented 3 years ago

In GitLab by @wtbarnes on Jul 27, 2021, 13:04

Yep. Sorry I should've been a bit more explicit. I meant the aiapy docs specifically, not the SDO/AIA user guide.

nabobalis commented 3 years ago

In GitLab by @derosaml on Jul 27, 2021, 13:14

I don't think the aiapy landing page is too bad. There isn't that much text.

I assume most newbie users will be looking for either the "Getting started" or "Example gallery" sections, which are at the top of the list, so that's good.

Adding a "How do I ..." section for more intermediate users isn't a bad idea, though.

nabobalis commented 2 years ago

In GitLab by @wtbarnes on Oct 27, 2021, 11:10

I'm going to close this as !97 greatly improved the look of the landing page so I'm going to close this for now.