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

Add documentation describing workflow design choices #84

Open
scwatts opened this issue Aug 7, 2024 · 0 comments
Open

Add documentation describing workflow design choices #84

scwatts opened this issue Aug 7, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@scwatts
Copy link
Collaborator

scwatts commented Aug 7, 2024

Overview

  • in order to assist accessibility to developers documentation on design choices should be made available
  • this should also include other relevant information such as less used Groovy syntax
  • it has been recommended to include this documentation in an existing file rather that a new file e.g.
    • README.md
    • docs/usage.md
    • under relevant workflow/subworkflow NF files

Initial discussion

  1. Initial release review [DO NOT MERGE] #29 (comment)
@scwatts scwatts added the enhancement New feature or request label Aug 7, 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