search

OpenMS / OpenMS-docs

OpenMS Documentation.
https://openms.readthedocs.io
BSD 3-Clause "New" or "Revised" License
2 stars 18 forks source link

move command line to TOPP tools? #131

Open timosachsenberg opened 2 years ago

timosachsenberg commented 2 years ago

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

Expected behaviour

OpenMS Installation

Additional context

axelwalter commented 2 years ago

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?

axelwalter commented 2 years ago

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

greengypsy commented 2 years ago

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

axelwalter commented 2 years ago

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