OpenMS/OpenMS-docs

move command line to TOPP tools?

Opened this issue · 4 comments

Would it make sense to move:
https://greengypsy-staging-openms.readthedocs.io/en/final-touches/docs/openms-applications-and-tools/command-line-interface.html
somehow into:
https://greengypsy-staging-openms.readthedocs.io/en/final-touches/docs/openms-applications-and-tools/topp-tools/introduction-to-topp.html

because it is kind of a concept of the TOPP tools.

Read Existing Documentation

I have checked the following places for the error:

Create OpenMS Bug Report

I have created the bug report in OpenMS for any pipeline errors.

Description of the documentation bug

  • I have attached screenshots of the incorrect documentation

Expected behaviour

OpenMS Installation

  • Version:

Additional context

The User Quickstart guide contains a lot of specific information for TOPP tools, such as how to add an INI file or change parameters in CLI or TOPPAS.
Could the Quickstart be restructured to be an overview that links to the specific pages instead?

In the TOPP section, we could mention that you can call a TOPP tool in different ways like CLI, KNIME, Galaxy...

If we do that, then I think it should be called a Command Line Interface Quickstart guide.

The Quickstart guide should be very general and act like a hub to the other topics such as:

  • What is OpenMS?
  • Background (the table that's already their)
  • Get familiar with TOPP tools (underline their central role)
  • Choose your way to use OpenMS (use pre-defined workflows, build your own workflow, scripting)
  • Installation on Windows, Linux, Mac buttons