diff options
5 files changed, 86 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 1f2ce3f3..649efb31 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -15,6 +15,7 @@ Poezio documentation
+ quickstart
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 78df333f..4e8033ff 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -1,3 +1,5 @@
+.. _install:
Installing poezio
diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst
index 1ea4d952..701aa59c 100644
--- a/doc/source/plugins/index.rst
+++ b/doc/source/plugins/index.rst
@@ -25,7 +25,7 @@ will override the one in :file:`../plugins`), or if it is a plugin you made.
Plugin autoload
-Use the :term:`plugins_autoload` optionto select which plugins should be
+Use the :term:`plugins_autoload` option to select which plugins should be
loaded on startup. The value is a list of plugin names separated by colons,
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
new file mode 100644
index 00000000..40e70371
--- /dev/null
+++ b/doc/source/quickstart.rst
@@ -0,0 +1,78 @@
+Quickstart guide
+This page is an attempt at provinding first aid to new users, who must
+first follow the :ref:`Install Guide <install>` to get a working poezio.
+Reading the more detailed:ref:`Usage page <usage>` is recommended to get
+a deeper understanding of poezio.
+Anonymous usage
+If you run poezio right after installing, you will get connected to the
+default anonymous server, which allows you to join rooms, and talk to people.
+Joining rooms
+The :term:`/join command </join>` allows you to join a chatroom and start
+talking to people right away. It opens a new :ref:`muctab`.
+Talking to people
+You can use the :ref:`/message` command if you know the address of people
+you want to talk to. This will open a :ref:`conversationtab`.
+Normal usage
+In order to use an account, you have to edit the :ref:`config` first,
+to set the account address and password (optionally). Sadly, poezio doesn’t
+allow account creation yet, so if you don’t have an account you will have
+to either use another client like gajim_ to create your account, or stay
+in anonymous mode.
+After obtaining an account and setting the :term:`jid` config option to
+the right value, you should go through the configuration file to get
+an overview of the different configuration options available.
+Joining rooms
+Just as in the anonymous mode, the :term:`/join command </join>` allows you
+to join a chatroom and start talking to people right away. It opens a new
+Talking to people
+Just as in the anonymous mode, you can use the :ref:`/message` command if
+you know the address of people you want to talk to. This will open a
+Adding people
+However, one of the benefits of having an account is to have contacts, see
+when they are online and offline, see their activity, mood, etc. To this end,
+you should add the people you know to your :ref:`contact list <rostertab>`.
+The :ref:`rostertab` is the tab numbered ``0``, and the only one which is
+always open. To add people, use :term:`/add`, to accept a contact request use
+Using end-to-end encryption
+To use OTR end-to-end encryption, you have to :ref:`enable <plugins-doc>` the
+:ref:`OTR plugin <otr-plugin>`. The plugin requires python-potr for python3, so
+make sure you have it installed first.
+After that, you can enable the OTR plugin with ``/load otr``. Further usage is
+discussed in the :ref:`plugin documentation <otr-plugin>`.
+.. _gajim:
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index ca43077b..53387325 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -1,3 +1,5 @@
+.. _usage:
@@ -96,6 +98,8 @@ Contact list tab
:ref:`Specific shortcuts <rostertab-keys>`
+.. note:: The contact list also called a roster in XMPP terms.
This is a unique tab, always numbered **0**. It contains the list of your
contacts. You can add (:term:`/add`, :term:`/accept`), remove
(:term:`/remove`) and search contacts from there, and you can open