summaryrefslogtreecommitdiff
path: root/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'source/index.rst')
-rw-r--r--source/index.rst28
1 files changed, 23 insertions, 5 deletions
diff --git a/source/index.rst b/source/index.rst
index db62934..8ecf58f 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -1,27 +1,45 @@
-.. CAcert code documentation documentation master file, created by
+.. CAcert code documentation master file, created by
sphinx-quickstart on Fri Oct 26 23:40:43 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to CAcert code documentation's documentation!
-=====================================================
+CAcert code documentation
+=========================
This is a work in progress documentation of the CAcert web application source
-code at https://git.cacert.org/gitweb/?p=cacert.git.
+code in the `release` branch of the :cacertgit:`cacert-devel`.
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.
+The code repository is mirrored to the :github:`cacert-devel` to encourage
+contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
+
.. toctree::
:maxdepth: 2
:caption: Contents:
+ general
+ directories
+ database
+ signer
+ building
+ glossary
+
+Filesystem structure
+--------------------
+
+The file system structure as of 2018-10-27 looks like shown below:
+
+.. literalinclude:: structure.txt
+ :language: text
+ :encoding: utf-8
+
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`