From 4ad732a7486b24320561f41868abb267d408f429 Mon Sep 17 00:00:00 2001 From: nsheff Date: Thu, 13 Jun 2024 08:40:39 -0400 Subject: [PATCH] more manuscript organization --- docs/geniml/README.md | 11 ++++++++--- mkdocs.yml | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/geniml/README.md b/docs/geniml/README.md index 1676f42..05b2da3 100644 --- a/docs/geniml/README.md +++ b/docs/geniml/README.md @@ -22,9 +22,14 @@ As of Feburary 2024, this package and its documentation are undergoing rapid dev pip install --user --upgrade geniml ``` -## Modules and resources by publication +## Modules and resources -`geniml` is organized into modules. The modules section gives an [overview of each module](modules.md). `geniml` includes many genomic interval analysis methods published in a variety of separate publications. If you're coming here from a manuscript, you can also find the relevant tutorials by visiting the landing page for the publication of interest: +### Organization + +`geniml` is organized into modules. The modules section gives an [overview of each module](modules.md). + +### Browsing by publication + +If you're coming here from a manuscript, you might find it easier to identify the tutorials relevant for a particular manuscript by visiting the landing page for the publication of interest. You can find documentation organized by manuscript in the [manuscripts section](../citations.md). -- [Rymuza et al. 2024](manuscripts/rymuza2024.md) diff --git a/mkdocs.yml b/mkdocs.yml index 8596591..27a46cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,7 +116,7 @@ nav: - Changelog: geniml/changelog.md - Gtars: - Gtars: gtars/README.md - - How to cite: + - Manuscripts: - How to cite: citations.md - Published manuscripts: - Gharavi et al. 2021: manuscripts/gharavi2021.md