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

WF Guide: user-friendly hints #302

Open
Tracked by #337
lena-hinrichsen opened this issue Mar 23, 2022 · 1 comment
Open
Tracked by #337

WF Guide: user-friendly hints #302

lena-hinrichsen opened this issue Mar 23, 2022 · 1 comment
Assignees

Comments

@lena-hinrichsen
Copy link
Member

lena-hinrichsen commented Mar 23, 2022

At the moment, it's not 100% obvious where to find the documentation of parameters for each processor . We want to implement a help button (or something similar) to the Workflow Guide, opening a popup window describing how to open the information about parameters (also how to use the sidebar).

The Workflow sections in the GitHub Wiki should also link to the (coressponding sections in the) WF Guide on the website.

plus: message in the wiki about the fact that you find more information on the website (GH Wiki is for contributing, Website is for reading)

@bertsky
Copy link
Collaborator

bertsky commented Mar 17, 2023

The popup or help button should IMO also link to the respective tool's README, which often provides more depth/structure and background that the plaintext help strings of the processor and tool json.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants