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

Turn Wiki for Repo into User Guide #73

Open
2 of 8 tasks
egrace479 opened this issue Oct 19, 2023 · 7 comments
Open
2 of 8 tasks

Turn Wiki for Repo into User Guide #73

egrace479 opened this issue Oct 19, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@egrace479
Copy link
Member

egrace479 commented Oct 19, 2023

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?
  • Different versions/releases of Andromeda (eg., QUEST 2023, latlonCover, Quest 2024) with descriptions and links to that particular version.
  • Why some columns might be dropped and what to do about it (eg., Inform users why columns are excluded #68)
  • Fetch data information:
@egrace479 egrace479 converted this from a draft issue Oct 19, 2023
@egrace479 egrace479 added the documentation Improvements or additions to documentation label Oct 19, 2023
@egrace479
Copy link
Member Author

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
Copy link
Member Author

egrace479 commented Feb 2, 2024

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
Copy link
Collaborator

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

@egrace479
Copy link
Member Author

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
Copy link
Collaborator

johnbradley commented Feb 22, 2024

No. Right now this is the main Andromeda screen running on huggingface:
Screenshot 2024-02-22 at 10 17 47 AM
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
Copy link
Member Author

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
Copy link
Member Author

egrace479 commented Mar 8, 2024

Thoughts on organization of our user/admin guide:

  • 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.
  • Page with more details on Andromeda and the implementation:
    • Cover things like why some columns might be dropped, general column requirements.
  • Fetch data page:
    • Options for getting data
    • Tools that can be/are applied (latlonCover & SatRGB)

@egrace479 egrace479 moved this from Todo to In Progress in Andromeda Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

No branches or pull requests

4 participants