docs section in index, tabs documentation link

biocypher · Jul 29, 2024 · 38a25df · 38a25df
1 parent f6282ac
commit 38a25df
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 6 deletions.
diff --git a/docs/images/boxplot-naive-vs-biochatter.pdf b/docs/images/boxplot-naive-vs-biochatter.pdf
diff --git a/docs/images/dotplot-per-task.pdf b/docs/images/dotplot-per-task.pdf
diff --git a/docs/images/dotplot-per-task.png b/docs/images/dotplot-per-task.png
diff --git a/docs/images/scatter-per-quantisation-name.pdf b/docs/images/scatter-per-quantisation-name.pdf
diff --git a/docs/images/scatter-per-quantisation-name.png b/docs/images/scatter-per-quantisation-name.png
diff --git a/docs/images/scatter-quantisation-accuracy.pdf b/docs/images/scatter-quantisation-accuracy.pdf
diff --git a/docs/images/scatter-size-accuracy.pdf b/docs/images/scatter-size-accuracy.pdf
diff --git a/docs/images/stripplot-extraction-tasks.png b/docs/images/stripplot-extraction-tasks.png
diff --git a/docs/images/stripplot-per-model.png b/docs/images/stripplot-per-model.png
diff --git a/docs/images/stripplot-rag-tasks.pdf b/docs/images/stripplot-rag-tasks.pdf
diff --git a/docs/images/stripplot-rag-tasks.png b/docs/images/stripplot-rag-tasks.png
diff --git a/docs/index.md b/docs/index.md
@@ -74,3 +74,10 @@ paid OpenAI TTS can be used without this extra)
 - `streamlit`: support for streamlit UI functions (used in BioChatter Light)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Python](https://img.shields.io/pypi/pyversions/biochatter)](https://www.python.org) [![PyPI version](https://img.shields.io/pypi/v/biochatter)](https://pypi.org/project/biochatter/) [![Downloads](https://static.pepy.tech/badge/biochatter)](https://pepy.tech/project/biochatter) [![CI](https://github.com/biocypher/biochatter/actions/workflows/ci.yaml/badge.svg)](https://github.com/biocypher/biochatter/actions/workflows/ci.yaml) [![Latest image](https://img.shields.io/docker/v/biocypher/chatgse)](https://hub.docker.com/repository/docker/biocypher/chatgse/general) [![Image size](https://img.shields.io/docker/image-size/biocypher/chatgse/latest)](https://hub.docker.com/repository/docker/biocypher/chatgse/general) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/biocypher/biochatter/blob/main/CONTRIBUTING.md)
+
+## Documentation and Tutorials
+
+For a description of the features of the framework, see the `Features` option in
+the main menu. For examples of usage and customisation, check out the 
+`Vignettes` section. For a more detailed reference of functions and classes, see
+the `API Reference`. 
diff --git a/docs/vignette-custom-bclight-simple.md b/docs/vignette-custom-bclight-simple.md
@@ -63,10 +63,10 @@ cd pole
 docker-compose up -d
 ```
 
-We are constantly expanding our repertoire of BioChatter Light tabs, so check
-back for more options in the future. Creating your own tabs is also accessible
-via our modular architecture and the simple [Streamlit](https://streamlit.io)
-framework for UI design. Check the codebase of [BioChatter
+We are constantly expanding our [repertoire of BioChatter Light
+tabs](https://github.com/biocypher/biochatter-light?tab=readme-ov-file#tab-selection),
+so check back for more options in the future. Creating your own tabs is also
+accessible via our modular architecture and the simple
+[Streamlit](https://streamlit.io) framework for UI design. Check the [advanced
+vignette](vignette-custom-bclight-advanced.md) and the codebase of [BioChatter
 Light](https://github.com/biocypher/biochatter-light) for more information.
-
-<!-- TODO create docs for the tabs and their env names -->