Mercurial > libervia-backend

diff doc/index.rst @ 2946:ce16847a7b6d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: documentation first draft: this patch starts the local documentation, existing documentation will be imported from wiki/other places to this folder and updated. This doc is using reStructuredText format and will be generated with Sphinx.
author Goffi <goffi@goffi.org>
date Fri, 22 Feb 2019 18:58:59 +0100
parents
children 8ec35cf13f66
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst	Fri Feb 22 18:58:59 2019 +0100
@@ -0,0 +1,34 @@
+=========================
+Salut à Toi documentation
+=========================
+
+Welcome to Salut à Toi's documentation. You'll find here both end-user and developer documentations.
+
+Salut à Toi (or SàT) is a Libre communication ecosystem based on XMPP standard. It allows you to do many things such as:
+
+- instant messaging
+- (micro)blogging
+- file sharing
+- managing photo albums
+- organizing/managing events
+- handling tasks
+- etc.
+
+It features many interfaces (desktop, mobile, web, command line, console), and is multi-platforms.
+
+You can follow this documentation to learn more on it, or join our official XMPP room at `sat@chat.jabberfr.org <xmpp:sat@chat.jabberfr.org?join>`_ (also available via a `web link <https://chat.jabberfr.org/converse.js/sat@chat.jabberfr.org>`_)
+
+
+.. toctree::
+   :caption: Contents:
+   :maxdepth: 3
+
+   installation.rst
+   /jp/index.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`