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

Add documentation about using the web interface #46

Open
astrophpeter opened this issue Jul 25, 2022 · 1 comment
Open

Add documentation about using the web interface #46

astrophpeter opened this issue Jul 25, 2022 · 1 comment
Labels
Difficulty: entry level documentation Improvements or additions to documentation feature request Use on issues that use the feature request template

Comments

@astrophpeter
Copy link
Collaborator

🚀 Feature Request

Is your feature request related to a problem? Please describe.

  • There is no documentation explaining how to use the blast web interface, we need to fix that!

Describe the solution you'd like

Add a section to the documentation that shows screenshots of each card display on the website and explains what is going on. Something very similar to YSE_PZ read the docs would be amazing: https://yse-pz.readthedocs.io/en/latest/dashboards.html

@astrophpeter astrophpeter added feature request Use on issues that use the feature request template Difficulty: entry level labels Jul 25, 2022
@astrophpeter astrophpeter changed the title Add documentation about using web interface Add documentation about using the web interface Jul 25, 2022
@astrophpeter astrophpeter added the documentation Improvements or additions to documentation label Jul 28, 2022
@manning-ncsa
Copy link
Collaborator

@djones1040 Documentation like YSE_PZ has for the web interface definitely looks nice and is informative, but in practice there are a few reasons I actually think we should not write such documentation. Documenting the UI places an extra burden to update the screenshots and text to stay in sync with whatever changes are made to the UI, and this is challenging given the typical developer resources. More importantly, though, the web interface should be as intuitive and self-explanatory as possible; at this point, software users do not expect to need an external manual to operate a UI and are as likely to abandon the software as they are to seek out such documentation. That being said, any work we would put into UI documentation we could instead devote to the UI itself, both in improving the design and adding in situ documentation in the form of tooltips, text on the page, etc that are tightly coupled to the page source code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: entry level documentation Improvements or additions to documentation feature request Use on issues that use the feature request template
Projects
None yet
Development

No branches or pull requests

2 participants