nf-core / nf-core/drugresponseeval
Docs/Usage more beginner-friendly
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Nextflow
- Stars
- 29
- Forks
- 11
- Avg merge
- 21h 44m
- Merged PRs (30d)
- 1
Description
Docs/usage can be made more digestible for beginners
Originally posted by @sateeshperi in https://github.com/nf-core/drugresponseeval/pull/32#pullrequestreview-2981702326
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the docs/usage material referenced in the issue and compare it with the beginner audience described. Determine which sections or explanations are difficult to follow, then update the usage documentation so a beginner can understand the workflow and verify the result by reviewing the revised page end to end.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100