Generate TreeOfLife Documentation

Open
#23 0 comments 0 reactions 3 assignees View on GitHub

@thompsonmj is already working on this.

Since Apr 22, 2025.

Assessment

This issue has not been assessed yet.

Description

documentation

We need proper documentation under a docs/ folder or potentially a MkDocs site since this is going to be quite large and complex. This will include:

  • Purpose of these tools (generation of TreeOfLife-200M, etc.)
  • How these tools fit into the processing (i.e., download with distributed-downloader, then the filtering, processing, etc.)
    • This repo will contain multiple processing stages from simpler initial source dataset-specific (EOL, GBIF, BIOSCAN, FathomNet, LILA) to more use-case specific and overall dataset creation.
    • Where include relation to TaxonoPy.
    • This will be the Reproduce the dataset repo.
  • How each tool works, their uses, etc.
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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.