update docs

COMBINE-lab · May 13, 2022 · 41770ae · 41770ae
1 parent a120443
commit 41770ae
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,7 +18,7 @@ It makes use of the selective-alignment and tag processing framework of
    :maxdepth: 2
    :caption: Contents:
 
-   other_resources
+   overview
    installing
    getting_started
    commands

diff --git a/docs/source/other_resources.rst → docs/source/overview.rst b/docs/source/other_resources.rst → docs/source/overview.rst
@@ -1,3 +1,10 @@
+Overview
+========
+
+`alevin-fry`` is a suite of tools for the rapid, accurate and memory-frugal processing single-cell and single-nucleus sequencing data. It consumes RAD files generated by `salmon alevin`, and performs common operations like generating permit lists, and estimating the number of distinct molecules from each gene within each cell. The focus in `alevin-fry`` is on safety, accuracy and efficiency (in terms of both time and memory usage).
+
+You can read the paper describing alevin fry, "Alevin-fry unlocks rapid, accurate, and memory-frugal quantification of single-cell RNA-seq data" [here](https://www.nature.com/articles/s41592-022-01408-3), and the pre-print [on bioRxiv](https://www.biorxiv.org/content/10.1101/2021.06.29.450377v1).
+
 Other resources for alevin-fry
 ==============================
 
@@ -22,7 +29,7 @@ of our `GitHub issues page <https://github.com/COMBINE-lab/alevin-fry/issues>`_.
 Quality Control
 ---------------
 
-Support for `alevin-fry` in the `alevinQC <https://github.com/csoneson/alevinQC>`_ package is imminent.
+The `alevinQC <https://github.com/csoneson/alevinQC>`_ package supports quality control of `alevin-fry` processed data.
 
 Easy loading of USA-mode data
 -----------------------------