Documentation character assassination

[DavidT3]

First step to improving the documentation is going to be to just read through all of it, and be really critical of what is in it, how it is laid out, and how I presented things.

This is not an incredibly urgent project, so we can do this piecemeal over time - I think maybe a separate notes project entry for each section will be the way to go, so everyone can collate their notes about a particular bit in one place.

The two main things we want to achieve with this (I think, please everyone say if they think there is something else critical we need to improve about the docs) is that the way I wrote the tutorials (for instance) focuses too much on the details of how things are working, which most users don't want or need to know; and the other thing is that the generalised tutorials should be supplemented by very targeted 'case studies' like we have in DAXA docs (these would help someone achieve a specific scientific goal, like say measuring R500s for a sample of clusters).

[DavidT3]

Put introduction notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88580574&issue=DavidT3%7CXGA%7C1280

Put installation notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581126&issue=DavidT3%7CXGA%7C1281

Put tutorial notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581456&issue=DavidT3%7CXGA%7C1282

Put advanced tutorial notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581540&issue=DavidT3%7CXGA%7C1283

Put XGA pipelines notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581615&issue=DavidT3%7CXGA%7C1284

Put 'under the hood' notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581704&issue=DavidT3%7CXGA%7C1285

Put any other notes here

https://github.com/users/DavidT3/projects/10/views/1?pane=issue&itemId=88581763&issue=DavidT3%7CXGA%7C1286

[DavidT3]

@jessicapilling Did some work to convert the documentation to multi-mission (see here for a non-public docs build for the integrate multi-mission branch ), so I suggest reviewing that one, or waiting until multi-mission is in the main branch.

@rz-wang You'll be very helpful in this endeavour because you've not really used XGA, so will be able to give us a relatively fresh perspective. Also, hopefully this will help you understand what makes good documentation, which you'll need to write for your Chandra features.