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

DRAM v2 README has too much hard coded things in it (like the --help output) #373

Open
madeline-scyphers opened this issue Oct 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@madeline-scyphers
Copy link
Member

Though it is nice to see the --help output in the README, it shouldn't go there since if the CLI output info changes, you often forget to update the README, and then your docs are inaccurate. You forget to add new options, update, etc. https://nf-co.re/docs/usage/introduction has some examples on how to build documentation automatically (for things like readthedocs) that come from your CLI stuff. So you reduce the number of places it comes from. You update it in as few of places as possible so your docs don't get out of date.

@madeline-scyphers madeline-scyphers added the documentation Improvements or additions to documentation label Oct 17, 2024
@madeline-scyphers madeline-scyphers added this to the v2 milestone Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant