From 8e7a3d8a172f62e13833f4d033b52e0cd38d66f6 Mon Sep 17 00:00:00 2001
From: Adam Janovsky
Date: Tue, 26 Apr 2022 11:41:58 +0200
Subject: populate docs structure

---
 docs/index.md         | 14 ++++++++++----
 docs/installation.md  |  3 +++
 docs/quickstart.md    |  3 +++
 docs/tutorial.md      |  3 +++
 docs/web_dashboard.md |  3 +++
 5 files changed, 22 insertions(+), 4 deletions(-)
 create mode 100644 docs/installation.md
 create mode 100644 docs/quickstart.md
 create mode 100644 docs/tutorial.md
 create mode 100644 docs/web_dashboard.md

diff --git a/docs/index.md b/docs/index.md
index b88dd91c..8c43766c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,16 +1,22 @@
 # Sec-certs documentation
 
-The documentation currently does not have all modules documented with `autodoc`. Most of the API showcases are documented in the *notebooks* examples below. If you want, you can run the notebooks. They are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks).
+![](_static/logo.svg)
 
-## Notebooks
+There are three main parts of this documentation. *User's guide* describes high-level use of our tool. Driven by this knowledge, you can progress to *Notebook examples* that showcase most of the API that we use in the form of Jupyter notebooks. The documentation currently does not have all modules documented with `autodoc`, so for the API reference, you must directly inspect the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/sec_certs) module. If you want, you can run the notebooks as they are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks). If you are interested in contributing to our project or in other aspects of our development, you can consult the relevant *GitHub artifacts*
+
+```{toctree}
+:caption: User's guide
+installation.md
+quickstart.md
+tutorial.md
+web_dashboard.md
+```
 
 ```{toctree}
 :caption: Notebook examples
 notebooks/dataset.ipynb
 ```
 
-## GitHub artifacts
-
 ```{toctree}
 :maxdepth: 2
 :caption: GitHub artifacts
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 00000000..0e6c025a
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,3 @@
+# Installation
+
+TBA
\ No newline at end of file
diff --git a/docs/quickstart.md b/docs/quickstart.md
new file mode 100644
index 00000000..b40bab01
--- /dev/null
+++ b/docs/quickstart.md
@@ -0,0 +1,3 @@
+# Quickstart
+
+TBA
\ No newline at end of file
diff --git a/docs/tutorial.md b/docs/tutorial.md
new file mode 100644
index 00000000..47e78870
--- /dev/null
+++ b/docs/tutorial.md
@@ -0,0 +1,3 @@
+# Tutorial
+
+TBA
\ No newline at end of file
diff --git a/docs/web_dashboard.md b/docs/web_dashboard.md
new file mode 100644
index 00000000..a5909db3
--- /dev/null
+++ b/docs/web_dashboard.md
@@ -0,0 +1,3 @@
+# Web dashboard
+
+TBA
\ No newline at end of file
-- 
cgit v1.3.1