Turn Wiki for Repo into User Guide

Imageomics / Andromeda

A website that enables users to explore high-dimensional image data

http://andromeda.imageomics.org/

MIT License

2 stars 1 forks source link

Turn Wiki for Repo into User Guide #73

Open egrace479 opened 9 months ago

egrace479 commented 9 months ago

Andromeda needs a User Guide!

We should describe the project:

[ ] What Andromeda is compared to the data fetching.
[ ] Data limitations (starts getting crowded as data point numbers increase, especially with images).
[ ] What is QUEST?
[x] Different versions/releases of Andromeda (eg., QUEST 2023, latlonCover, Quest 2024) with descriptions and links to that particular version.
[x] Why some columns might be dropped and what to do about it (eg., #68)
[ ] Fetch data information:
- [ ] latlonCover info (including eg., #71)
- [ ] SatRGB and general extra info (upcoming).

egrace479 commented 8 months ago

As discussed here, this will also serve as our general documentation, so for admin use as well. To this point, it will also allow us to record our prior configurations for others setting up their own instance or ourselves in case we wish to return to them for some reason.

egrace479 commented 5 months ago

Once this is properly set up, we'll want to add links to the documentation from the README in the repo and in the HF repo:

[ ] Link to Docs in GH README
[ ] Link to Docs in HF README

johnbradley commented 4 months ago

Let's add a link from the App to the documentation too.

egrace479 commented 4 months ago

Let's add a link from the App to the documentation too.

As in this note on the GH README?

For instructions on building and running the Docker container see Developing with Docker.

johnbradley commented 4 months ago

No. Right now this is the main Andromeda screen running on huggingface:

My thought is users might visit the page and not realize we have a user guide. So my suggestion is to add a link to this page that opens the User Guide section related to user interaction.

egrace479 commented 4 months ago

Ah, like with the data dashboard link to documentation. That seems like a good idea, though we still need to write most of the user guide. Screenshot 2024-02-22 at 10 38 27 AM

egrace479 commented 4 months ago

Thoughts on organization of our user/admin guide:

[x] Home page can give overview of Andromeda
[ ] QUEST page to discuss what QUEST is (sections for 2023, 2024, and on to the future). This could focus on descriptions, then point to appropriate Prior Configurations for more information on the technical details.
[ ] GUI-type page? Something to cover the limitations of space and similar.
[x] Page with more details on Andromeda and the implementation:
- [x] Cover things like why some columns might be dropped, general column requirements.
[ ] Fetch data page:
- [x] Options for getting data
- [ ] Tools that can be/are applied (latlonCover & SatRGB)