Begin restructuring user docs into a user manual

Change-Id: I36c242f05dbf60234514706eade55d494ee3307d

general/index.rst

-#######
-General
-#######
-
-This chapter introduces Jami and tries to answer the most common
-questions.
-
-.. toctree::
-   :maxdepth: 1
-
-   introduction
-   faq

index.rst

@@ -21,6 +21,6 @@ contribute<guides/how-to-contribute-to-this-documentation>`!
 .. toctree::
    :maxdepth: 2
 
-   general/index
+   user/index
    guides/index
    technical/index

guides/how-to-report-bugs.md → user/bug-report-guide.md

@@ -3,18 +3,21 @@ project.  As such, we cannot answer and tag all of the opened issues
 immediately, but we do notice and read them.  Good bug reports provide
 us important feedback, which we thank you for and always appreciate.**
 
-How to report bugs and issues
-=============================
+Bug report guide
+================
+
+This guide includes step-by-step instructions for reporting bugs and
+issues you encounter in Jami.
 
 Set up your environment
 -----------------------
 
--   Be ready for data loss.  Back up your account and link your
-    account to as many devices as possible.
+- Be ready for data loss.  Back up your account and link your account
+  to as many devices as possible.
 - Install the latest version (or even a beta version) of Jami.
-    Reporting bugs/issues against older versions is less useful,
-    and there is a likelihood of it already having been fixed in
-    newer versions.
+  Reporting bugs/issues against older versions is less useful, and
+  there is a likelihood of it already having been fixed in newer
+  versions.
 
 How to report a bug
 -------------------
@@ -42,12 +45,12 @@ too big due to icon size)
 
 - If you have precise steps to reproduce it (great!) you're on your
   way to creating a helpful bug report.
--   If you can reproduce occasionally, but not after following
-    specific steps, please provide additional information about the
-    issue to help others understand and try to reproduce it.
--   If you can't reproduce the problem, there may be little chance of
-    it being reasonably fixable.  If you do report it, please try your
-    best to provide as much information/clues about its occurrence as
+- If you can reproduce occasionally, but not after following specific
+  steps, please provide additional information about the issue to help
+  others understand and try to reproduce it.
+- If you can't reproduce the problem, there may be little chance of it
+  being reasonably fixable.  If you do report it, please try your best
+  to provide as much information/clues about its occurrence as
   possible.
 
 5\. Make sure your software is up to date.  Ideally, test an

general/faq.rst → user/faq.rst

@@ -15,7 +15,7 @@ Basics
 What is Jami?
 ~~~~~~~~~~~~~
 
-See the :doc:`Introduction <introduction>`.
+See the :doc:`introduction`.
 
 What does Jami mean?
 ~~~~~~~~~~~~~~~~~~~~
@@ -29,7 +29,7 @@ supported, and respects the freedom and privacy of the users.
 How can I make a bug report?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Please see the :doc:`../guides/how-to-report-bugs` guide.
+Please see the :doc:`bug-report-guide`.
 
 What makes Jami different from other communication platforms?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -238,7 +238,7 @@ centralized system you would use your password to authenticate with a
 public server where your account is stored.  Someone who knows your
 password could steal your identity.
 
-With Jami, your account is stored in a :ref:`folder <general/faq:Where
+With Jami, your account is stored in a :ref:`folder <user/faq:Where
 are the configuration files located?>` on your device.  **The password
 is only used to encrypt your account in order to protect you from
 someone who has physical access to your device.**
@@ -251,10 +251,10 @@ Why don't I have to register a username?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The most permanent, secure identifier is your :ref:`Jami ID
-<general/faq:Where is my Jami ID?>`, but since these are difficult to
-use for some people, you also have the option of registering a
-username.  Username registration requires a name server, such as
-Jami's default one at ``ns.jami.net``.
+<user/faq:Where is my Jami ID?>`, but since these are difficult to use
+for some people, you also have the option of registering a username.
+Username registration requires a name server, such as Jami's default
+one at ``ns.jami.net``.
 
 If you don't register a username, you can still choose to register one
 later at any time.
@@ -269,7 +269,7 @@ What is the difference between a username and a display name?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can use your username as an identifier.  The username points to
-your :ref:`Jami ID <general/faq:Where is my Jami ID?>`, which is your
+your :ref:`Jami ID <user/faq:Where is my Jami ID?>`, which is your
 permanent, secure identifier.  Two people cannot have the same
 username.
 
@@ -286,7 +286,7 @@ There are two ways to back up your account:
    devices.  You can find this option in the account settings page.
 2. Back up the :ref:`account archive <technical-overview:Account
    storage and backup>`.  This file can be found in the account files
-   :ref:`folder <general/faq:Where are the configuration files
+   :ref:`folder <user/faq:Where are the configuration files
    located?>`.  In some clients, you can export this archive from the
    account settings.
 
@@ -332,7 +332,7 @@ due to absence and lack of activity.
    that username anymore.
 
    To avoid losing your account **please** :ref:`back it up
-   <general/faq:How can I back up my account?>`!
+   <user/faq:How can I back up my account?>`!
 
 What happens when I link a new device?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -423,7 +423,7 @@ Read more about the Jami :doc:`../technical/Name-Server-Protocol`.
 How can I change the timeout for a call?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-In the ``dring.yml`` file (see :ref:`general/faq:Where are the
+In the ``dring.yml`` file (see :ref:`user/faq:Where are the
 configuration files located?`), you can change the ``ringingTimeout``
 (in seconds).
 
@@ -488,8 +488,7 @@ answer and check the code, or use wireshark or other tools.
 Generally, I (and as far as I know most other Jami developers) use the
 first scenario (sometimes the second one), and we surely can't test
 all the possible networks configurations we would like to, so if you
-discover a bug, please :doc:`open an issue
-<../guides/how-to-report-bugs>`.
+discover a bug, please :doc:`open an issue <bug-report-guide>`.
 
 Anyway, in these 3 scenarios, there are 3 main actions:
 
@@ -558,7 +557,7 @@ address of your VPN + TURN address if TURN is enabled
 
 Same as above, your public address is replaced by your VPN
 address. You can see it in the logs from daemon.
-See :ref:`guides/how-to-report-bugs:logs`.
+See :ref:`user/bug-report-guide:logs`.
 
 Tor
 ^^^
@@ -659,8 +658,8 @@ or:
        }
    }
 
-This file is :ref:`located in the same directory <general/faq:Where
-are the configuration files located?>` as ``dring.yml``.
+This file is :ref:`located in the same directory <user/faq:Where are
+the configuration files located?>` as ``dring.yml``.
 
 To check which options are supported, use the command ``ffmpeg -h
 encoder=[encoder_name]``, where ``encoder_name`` can be any of

user/index.rst

+###########
+User manual
+###########
+
+The Jami user manual introduces Jami and its features, provides
+additional information on methods of installing Jami, answers users'
+most common questions in the FAQ (frequently asked questions), and
+includes various user guides and tutorials for users, such as the
+:doc:`bug-report-guide` with step-by-step instructions for reporting
+bugs and issues.
+
+.. toctree::
+   :maxdepth: 1
+
+   introduction
+   features
+   faq
+   tutorials
+   bug-report-guide

general/introduction.rst → user/introduction.rst

@@ -32,10 +32,9 @@ secure connection, performing `Secure Real-time Transport Protocol
 (SRTP) communication which carries the media streams.
 
 For more on how Jami works, see the `Jami and how it empowers users
-<https://kelar.org/~bandali/talks/libreplanet-2021-jami.html>`_ talk
-by `Amin Bandali <https://kelar.org/~bandali/>`_, as well as the
-:doc:`Technical Overview <technical-overview>` for more in-depth
-information.
+<https://bndl.org/talks/jami-empowers-users.html>`_ talk by `Amin
+Bandali <https://bndl.org>`_, as well as the :doc:`Technical Overview
+<technical-overview>` for more in-depth information.
 
 Who makes Jami?
 ---------------