Create onboarding documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 28
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 7
Description
Write user guides covering running the Snakemake pipeline (replacing the old law run commands), cluster profile setup and required environment variables, waveform generation options, online pipeline architecture, and a v1 -> v2 migration reference for users familiar with the Law/Luigi workflow.
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 reviewing the current Snakemake pipeline entry point and existing documentation, then map the cluster profile setup, required environment variables, waveform options, online pipeline architecture, and Law/Luigi migration points. Done means users can follow the guides to run the pipeline, configure a cluster, choose waveform options, understand the architecture, and migrate from v1 to v2.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 56/100