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

Improve the documentation #7

Open
salmma opened this issue Oct 21, 2022 · 0 comments
Open

Improve the documentation #7

salmma opened this issue Oct 21, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@salmma
Copy link

salmma commented Oct 21, 2022

regarding: https://qhana.readthedocs.io/en/latest/index.html

please describe:

  • the purpose of QHAna
  • what an experiment ist
  • for what the plugins are, why I should use them, how they are related to an experiment
    such that a user who uses this tool for the first time has a better understanding of the tool and the different steps and make it more informative.

as eg described here https://quantil.readthedocs.io/en/latest/user-guide/qhana-new/

Is this https://quantil.readthedocs.io/en/latest/user-guide/qhana/ still required? If not please remove.

If QHAna should have a separate documentation then I would suggest to remove the detailed description from the QuAntiL documentation and just share a link to the QHAna documentation - to keep consistency - equivalent to the PatternAtlas (see landing page of the QuAntiL documentation).

@salmma salmma added the documentation Improvements or additions to documentation label Oct 21, 2022
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
None yet
Development

No branches or pull requests

2 participants