Documentation Review

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
jupyter-notebook
Domain
documentation

Research direction

Start by installing the package and reviewing the distributed-downloader-tools portion of the linked comment. Document the expected data at handoff and confirm that the installed package runs and that its integration with distributed-downloader is clear.

Written by the indexing model from the issue text.

Description

documentation

Make sure that when someone installs the package, it is runable---need not be perfect, but should work!

Clarity of integration/reliance on distributed-downloader:

  • status at handoff (i.e., what does the data look like after this process---as in what should it look like coming into this)
Dominant language
Jupyter Notebook
Stars
9
Forks
1
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from Imageomics/TreeOfLife-toolbox

All issues in Imageomics/TreeOfLife-toolbox

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.