Skip to content

Improve docs with more 'applied' examples #94

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

Open
jfy133 opened this issue Jan 22, 2025 · 2 comments
Open

Improve docs with more 'applied' examples #94

jfy133 opened this issue Jan 22, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jfy133
Copy link
Contributor

jfy133 commented Jan 22, 2025

A general issue I've had with the docs is that I often am unable to understand them in the context of my specific usecase: validating samplesheets.

It would be good to improve some of the docs to include more practical examples and 'best-practice' suggestins for most common usecases.

https://nfcore.slack.com/archives/C070369GP7T/p1737461104267239

@nvnieuwk nvnieuwk added the documentation Improvements or additions to documentation label Jan 31, 2025
@nvnieuwk nvnieuwk added this to the 2.5.0 milestone Mar 19, 2025
@nvnieuwk
Copy link
Collaborator

@jfy133 could you take a look at #141 if this is enough for you?

@jfy133
Copy link
Contributor Author

jfy133 commented May 16, 2025

I'm not really sure... I don't see any schema files in that PR, nor descriptions how the schema is working achieve the examples' goals

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

2 participants