summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2018-10-26 23:53:43 +0200
committerJan Dittberner <jandd@cacert.org>2018-10-26 23:53:43 +0200
commit8c7ed333c55b2570b27d6505a8f00a9e02d95051 (patch)
treef0b08569abb376f73b2cf4725f53fc3f09924f01
parenta5bb7e680bcc1950f70c13e37bab2b3e4d5639b1 (diff)
downloadcacert-codedocs-8c7ed333c55b2570b27d6505a8f00a9e02d95051.tar.gz
cacert-codedocs-8c7ed333c55b2570b27d6505a8f00a9e02d95051.tar.xz
cacert-codedocs-8c7ed333c55b2570b27d6505a8f00a9e02d95051.zip
Write a short introduction with the purpose of the documentation
-rw-r--r--source/index.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/source/index.rst b/source/index.rst
index 054b523..db62934 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -6,6 +6,13 @@
Welcome to CAcert code documentation's documentation!
=====================================================
+This is a work in progress documentation of the CAcert web application source
+code at https://git.cacert.org/gitweb/?p=cacert.git.
+
+The goal is to document the existing code base to give insight into its
+functionality and to support writing a specification for a potential
+reimplementation.
+
.. toctree::
:maxdepth: 2
:caption: Contents: