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

Write extensive documentation #51

Open
4 tasks
remiolsen opened this issue Nov 28, 2023 · 0 comments
Open
4 tasks

Write extensive documentation #51

remiolsen opened this issue Nov 28, 2023 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@remiolsen
Copy link
Member

remiolsen commented Nov 28, 2023

In RTD or whatever the cool kids use these days. Document:

  • Introduction with typical use cases
  • Input variations. Samplesheet, adapters, parameters.
  • Outputs. Each file and each line explained
  • Others. Troubleshooting? MQC integration?. Custom adapters.
@remiolsen remiolsen added the enhancement New feature or request label Nov 28, 2023
@remiolsen remiolsen added this to the 1.0.0 milestone Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant