scverse / scverse/scirpy

Split tutorials into "gallery"

Open
#733 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
265
Forks
50
Avg merge
9d 9h
Merged PRs (30d)
4

Description

Description of feature

The tutorials are getting quite lengthy and there are a lot of redundancies between BCR and TCR tutorial. I think it makes sense to split them up into a more modular "gallery" style, that showcases individual analyses. Overarching BCR and TCR tutorials can then refer to these sections.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing BCR and TCR tutorials and cataloging their overlapping analyses and lengthy sections. Done means individual analyses are organized as modular gallery entries, while the overarching BCR and TCR tutorials refer to those sections without the current redundancies.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.