Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Create and mantain protocol wiki #2017

Open
DStrelak opened this issue Jul 16, 2019 · 3 comments
Open

Create and mantain protocol wiki #2017

DStrelak opened this issue Jul 16, 2019 · 3 comments

Comments

@DStrelak
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Sometimes it's not so clear which protocols can be used at which part of the pipeline.

Describe the solution you'd like
Ideally, there should be a wiki with all the protocols, including references to the (white) papers, example workflow using them, and some info on how to set the input and how to interpret output of the protocol.

@delarosatrevin
Copy link
Member

This seems like a very broad and general issue...and not very actionable in a whole. Moreover, there are far more protocols on each plugin now. So the main documentation should come from the developers of each protocol.

@DStrelak
Copy link
Contributor Author

I totally agree. But I believe that it is justifiable to require the authors to create documentation for their plugins, and update said docs with each new version (if applicable).
In the long term, it would be beneficial for the authors, as documented software is, generally speaking, more often used.

@azazellochg
Copy link
Member

I think this issue was raised 4-5 years ago, good luck with that 🤣

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

No branches or pull requests

3 participants