docs: deploy dedicated docs pages

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Docs
+
+on:
+  pull: '*'  # delete line
+  push:
+    branches: '*'  # replace with [main, dev]
+  workflow_dispatch:
+
+jobs:
+
+  docs:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout zarp repository
+        uses: actions/checkout@v4
+
+      - name: Setup miniconda & zarp env
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: "3.10"
+          mamba-version: "*"
+          channels: conda-forge
+          channel-priority: true
+          auto-update-conda: false
+          activate-environment: zarp
+          environment-file: install/environment.yml
+          auto-activate-base: false
+
+      - name: Update zarp env with root. packages
+        run: mamba env update -p $CONDA_PREFIX -f install/environment.root.yml
+
+      - name: Update zarp env with dev. packages
+        run: mamba env update -p $CONDA_PREFIX -f install/environment.dev.yml
+
+      - name: Display all miniconda & env info
+        run: |
+          conda info -a
+          conda list
+
+      - name: Cache build artifacts
+        uses: actions/cache@v4
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+
+      - name: Install doc requirements
+        run: pip install -r docs/requirements.txt
+
+      - name: Publish docs
+        run: mkdocs gh-deploy --force --clean --verbose

docs/README.md

@@ -0,0 +1,69 @@
+<figure markdown>
+  ![ZARP logo](./images/zarp_logo.384px.png){ width="384" }
+</figure>
+
+# ZARP
+
+**Welcome to the _ZARP_ documentation pages!**
+
+_ZARP_ is a [Snakemake][snakemake] workflow ...
+
+TODO: Complete intro/summary section
+
+NOTE: Include references in `/includes/references.md`
+NOTE: Include abbreviations in `includes/abbreviations.md` (example: EAWNKWIMPR)
+NOTE: Include emojis (example: :rocket:)
+NOTE: Check out the [ZARP-cli docs pages](https://zavolab.github.io/zarp-cli/)
+for inspiration.
+NOTE: Check out [MKDocs](https://www.mkdocs.org/) and [Material for
+MkDocs](https://squidfunk.github.io/mkdocs-material/) docs for more info
+
+## How does it work?
+
+Briefly, when a _ZARP_ run is triggered, ...
+
+TODO: Complete section
+
+## How to cite
+
+If you use _ZARP_ in your work, please kindly cite the following article:
+
+**ZARP: A user-friendly and versatile RNA-seq analysis workflow**  
+_Maria Katsantoni, Foivos Gypas, Christina J. Herrmann, Dominik Burri, Maciej
+Bak, Paula Iborra, Krish Agarwal, Meric Ataman, Máté Balajti, Noè Pozzan, Niels
+Schlusser, Youngbin Moon, Aleksei Mironov, Anastasiya Börsch, Mihaela Zavolan,
+Alexander Kanitz_  
+F1000Research 2024, 13:533  
+<https://doi.org/10.12688/f1000research.149237.1>
+
+## Training materials
+
+Coming soon...
+
+## Info materials
+
+Coming soon...
+
+## Reach out
+
+There are several ways to get in touch with us:
+
+- For ZARP usage questions, please use the [_ZARP_ Q&A forum][zarp-qa]  
+  (requires [GitHub registration][github-signup])
+- For feature suggestions and bug reports, please use either the
+  [ZARP][zarp-issue-tracker] or [ZARP-cli][zarp-cli-issue-tracker] issue
+  tracker (requires [GitHub registration][github-signup])
+- For any other requests, please reach out to us via [email][contact]
+
+!!! info "Contributors welcome!"
+
+    Open source contributors are always welcome, for [_ZARP_][zarp],
+    [_ZARP-cli_][zarp-cli] or any other of the [Zavolab
+    projects][zavolab-gh]. Simply reach out by [email][contact] to schedule
+    an onboarding call.
+
+## Acknowledgements
+
+[![Zavolab](images/zavolab_logo.200px.png)](https://www.biozentrum.unibas.ch/research/research-groups/research-groups-a-z/overview/unit/research-group-mihaela-zavolan)
+[![Biozentrum, University of Basel](images/biozentrum_logo.200px.png)](https://www.biozentrum.unibas.ch/)
+[![Swiss Institute of Bioinformatics](images/sib_logo.200px.png)](https://www.sib.swiss/)

docs/guides/installation.md

@@ -0,0 +1,32 @@
+# Installation
+
+On this page, you will find out how to install _ZARP_ on your system.
+
+## Requirements
+
+Installation requires the following:
+
+- Linux (tested with Ubuntu 20.04; macOS has not been tested yet)
+- [Conda][conda] (tested with `conda 22.11.1`)
+- [Mamba][mamba] (tested with `mamba 1.3.0`)
+- [Singularity][singularity] (tested with `singularity 3.8.6`; not required
+  if you have root permissions on the machine you would like to install
+  _ZARP-cli_ on; in that case choose one of the `.root.` environment file
+  flavors [below](#3-install-app-dependencies))
+
+> Other versions, especially older ones, are not guaranteed to work.
+
+TODO: Add/replace requirements/versions
+
+## Installation steps
+
+### 1. Clone ZARP
+
+Clone the [ZARP workflow repository][zarp] with:
+
+```sh
+git clone git@github.com:zavolanlab/zarp
+# or: git clone https://github.com/zavolanlab/zarp.git
+```
+
+TODO: Add on...

docs/includes/abbreviations.md

@@ -0,0 +1 @@
+*[EAWNKWIMPR]: Example Abbreviation Where Nobody Knows What It Means, Please Remove

docs/includes/references.md

@@ -0,0 +1,12 @@
+[conda]: <https://docs.conda.io/projects/conda/en/latest/index.html>
+[contact]: <mailto:zavolab-biozentrum@unibas.ch>
+[github-signup]: <https://github.com/signup>
+[mamba]: <https://github.com/mamba-org/mamba>
+[singularity]: <https://sylabs.io/singularity/>
+[snakemake]: <https://github.com/snakemake/snakemake>
+[zarp]: <https://github.com/zavolanlab/zarp>
+[zarp-cli]: <https://github.com/zavolanlab/zarp-cli>
+[zarp-cli-issue-tracker]: <https://github.com/zavolanlab/zarp-cli/issues>
+[zarp-issue-tracker]: <https://github.com/zavolanlab/zarp/issues>
+[zarp-qa]: <https://github.com/zavolanlab/zarp/discussions>
+[zavolab-gh]: <https://github.com/zavolanlab>