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

Documentation Pages Missing #1781

Closed
slnickerson opened this issue Oct 25, 2022 · 1 comment · Fixed by #1768
Closed

Documentation Pages Missing #1781

slnickerson opened this issue Oct 25, 2022 · 1 comment · Fixed by #1768
Labels
bug Something isn't working documentation Explanation of code and concepts

Comments

@slnickerson
Copy link

Hello!

I'm not sure if this is the correct place to bring this up, but the documentation for Jdaviz does not include a section of who/where to ask for assistance (https://jdaviz.readthedocs.io/en/latest/index.html).

I'm trying to get Jdaviz running and I'm fairly certain instructions are missing on the documentation. There are the installation instructions, and I went through the conda route. However after that there are no instructions on how to launch the GUI or how to get the jdaviz command working on the command line (it does not for me).

On GitHub (https://github.com/spacetelescope/jdaviz) there is a small quick start section, that links to a quick start page that does not exist (https://jdaviz.readthedocs.io/en/latest/quickstart.html).

So in summary, it looks like the documentation needs:

  1. A quick start page to help people get it up and running
  2. Somewhere to ask for help. Because I cannot get it running but I do not know who to ask.

Thank you very much and I look forwards to using jdaviz!

@pllim
Copy link
Contributor

pllim commented Oct 25, 2022

Thanks. This will be fixed by #1768

@pllim pllim added bug Something isn't working documentation Explanation of code and concepts labels Oct 25, 2022
@pllim pllim mentioned this issue Oct 25, 2022
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Explanation of code and concepts
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants