git » chasquid » commit b1a4b0c

docs: Add a page for known issues

author Alberto Bertogli
2021-05-23 23:27:58 UTC
committer Alberto Bertogli
2021-05-24 00:01:16 UTC
parent ec7234c0a9cc8734368b9d0f18a8761b27672eb4
docs: Add a page for known issues

It's common that people running old releases (for example, because of
their Linux distribution version) run into issues that have already been
fixed.

It can be convenient to have a list of the most common known issues and,
when available, their workarounds.

This patch creates the documentation page for them, currently empty. It
will be filled in subsequent patches.
.mkdocs.yml +1 -0
docs/knownissues.md +11 -0 
diff --git a/.mkdocs.yml b/.mkdocs.yml
index 0d297a1..f1e1766 100644
--- a/.mkdocs.yml
+++ b/.mkdocs.yml
@@ -33,4 +33,5 @@ nav:
     - sec-levels.md
     - tests.md
     - relnotes.md
+    - knownissues.md
 
diff --git a/docs/knownissues.md b/docs/knownissues.md
new file mode 100644
index 0000000..9645ea4
--- /dev/null
+++ b/docs/knownissues.md
@@ -0,0 +1,11 @@
+
+# Known issues
+
+This file contains a list of the most common known issues, and the release
+range affected. It can be useful for people running older versions, to
+identify problems (and workarounds) faster.
+
+Entries are eventually be purged once their affected versions become uncommon,
+to prevent confusion.
+
+