From ccc5dd037fa2bb6db42e8252b4ecadaf5cb26704 Mon Sep 17 00:00:00 2001
From: El RIDO <elrido@gmx.net>
Date: Sun, 19 Feb 2023 08:32:10 +0100
Subject: [PATCH] update links, unify formats, add documentation index

---
 README.md     |  2 +-
 doc/README.md | 37 +++++++++++++++++++++++++++++++++++++
 tst/README.md | 13 ++++---------
 3 files changed, 42 insertions(+), 10 deletions(-)
 create mode 100644 doc/README.md

diff --git a/README.md b/README.md
index 3a1be5c5..e687a70c 100644
--- a/README.md
+++ b/README.md
@@ -96,7 +96,7 @@ file](https://github.com/PrivateBin/PrivateBin/wiki/Configuration):
 
 * [FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ)
 
-* [Installation guide](https://github.com/PrivateBin/PrivateBin/blob/master/INSTALL.md#installation)
+* [Installation guide](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Installation.md#installation)
 
 * [Configuration guide](https://github.com/PrivateBin/PrivateBin/wiki/Configuration)
 
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000..9bb7c77d
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,37 @@
+# PrivateBin Documentation
+
+## [Frequently Asked Questions](https://github.com/PrivateBin/PrivateBin/wiki/FAQ)
+
+Please have a look at these questions *before* opening an issue in this repo.
+
+## [Installation guide](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Installation.md#installation)
+
+Minimal requirements, hardening and securing your installation and initial
+configuration.
+
+## [Configuration guide](https://github.com/PrivateBin/PrivateBin/wiki/Configuration)
+
+Detailed guide on each configuration option and their effects.
+
+## [Templates](https://github.com/PrivateBin/PrivateBin/wiki/Templates)
+
+How to change an existing template or create your own, as well as an overview of
+the currently included templates.
+
+## [Translation guide](https://github.com/PrivateBin/PrivateBin/wiki/Translation)
+
+How to help translate PrivateBin and technical background on it's implementation.
+
+## [Developer guide](https://github.com/PrivateBin/PrivateBin/wiki/Development)
+
+Know how for participating in PrivateBins development.
+
+### [Generating Source Code Documentation](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Generating%20Source%20Code%20Documentation.md#generating-source-code-documentation)
+
+How to generate the source code API documentation, as found on the project
+website for [PHP](https://privatebin.info/codedoc/) and [JS](https://privatebin.info/jsdoc/)
+
+### [Running Unit Tests](https://github.com/PrivateBin/PrivateBin/blob/master/tst/README.md#running-all-unit-tests)
+
+How to run the PHP & JS unit tests, including a brief introduction to property
+based unit testing.
\ No newline at end of file
diff --git a/tst/README.md b/tst/README.md
index c8bb7519..db310e9b 100644
--- a/tst/README.md
+++ b/tst/README.md
@@ -1,5 +1,4 @@
-Running all unit tests
-======================
+# Running All Unit Tests
 
 Since it is non-trivial to setup all dependencies for our unit testing suite,
 we provide a docker image that bundles all of them into one container, both
@@ -34,8 +33,7 @@ well as the integrated unit testing utilities. See our [docker wiki
 page](https://github.com/PrivateBin/PrivateBin/wiki/Docker#janitor-image-with-cloud9-and-theia-webide-janitortechnologyprivatebin)
 for further details on this.
 
-Running PHP unit tests
-======================
+## Running PHP Unit Tests
 
 In order to run these tests, you will need to install the following packages
 and their dependencies:
@@ -75,8 +73,7 @@ $ phpunit ConfigurationCombinationsTest.php
 Note that it can take an hour or longer to run the several thousand tests.
 
 
-Running JavaScript unit tests
-=============================
+## Running JavaScript Unit Tests
 
 In order to run these tests, you will need to install the following packages
 and its dependencies:
@@ -112,8 +109,7 @@ $ cd PrivateBin/js
 $ nyc mocha
 ```
 
-Property based unit testing
----------------------------
+### Property Based Unit Testing
 
 In the JavaScript unit tests we use the JSVerify library to leverage property
 based unit testing. Instead of artificially creating specific test cases to
@@ -154,4 +150,3 @@ with the same RNG state as follows:
 ```console
 $ nyc mocha test --jsverifyRngState 88caf85079d32e416b
 ```
-