From aafa2f901fd38fe4c67ebb289e38727647ced885 Mon Sep 17 00:00:00 2001
From: tfuxu <73042332+tfuxu@users.noreply.github.com>
Date: Sun, 5 Mar 2023 19:01:05 +0100
Subject: [PATCH] content: update some .rst files and update README.md

---
 README.md           |  2 +-
 cli.rst             |  6 +++---
 index.rst           | 18 +++++++-----------
 installation.rst    |  2 +-
 troubleshooting.rst |  2 ++
 usage.rst           |  8 ++++----
 6 files changed, 18 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 121538a..6857741 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Documentation
+# Gradience User Documentation
 
 ## Setup
 
diff --git a/cli.rst b/cli.rst
index f300c88..9f00ced 100644
--- a/cli.rst
+++ b/cli.rst
@@ -24,7 +24,7 @@ If using Gradience as a Flatpak package, launch CLI with:
 Alternative approach:
 ---------------------
 
-Launch CLI with a dedicated command: `gradience-cli`
+Launch CLI with a dedicated command: ``gradience-cli``
 
 CLI global help:
 ----------------
@@ -177,9 +177,9 @@ Flatpak-overrides
 Raw JSON output
 ---------------
 
-Some commands contain local parameter `--json` to help developers in implementing interactions with Gradience. Currently it can only be used with a handful of available arguments, but there are plans to extend this feature to all arguments. This parameter when used with supported argument, will output argument result in JSON format.
+Some commands contain local parameter ``--json`` to help developers in implementing interactions with Gradience. Currently it can only be used with a handful of available arguments, but there are plans to extend this feature to all arguments. This parameter when used with supported argument, will output argument result in JSON format.
 
-Example with `favorites` command:
+Example with ``favorites`` command:
 
 .. code-block:: console
 
diff --git a/index.rst b/index.rst
index 8ceff05..38121c5 100644
--- a/index.rst
+++ b/index.rst
@@ -6,19 +6,15 @@
 Welcome to Gradience's documentation!
 =====================================
 
-.. automodule:: gradience
-   :members:
-
-
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+    :maxdepth: 2
+    :caption: Contents:
 
-   installation
-   setup
-   usage
-   troubleshooting
-   cli
+    installation
+    setup
+    usage
+    troubleshooting
+    cli
 
 
 Indices and tables
diff --git a/installation.rst b/installation.rst
index e960ad2..c80d957 100644
--- a/installation.rst
+++ b/installation.rst
@@ -63,7 +63,7 @@ You can either clone the public repository:
 
     $ git clone git://github.com/GradienceTeam/Gradience
 
-Or download the `tarball`_:
+or download the `tarball`_:
 
 .. code-block:: console
 
diff --git a/troubleshooting.rst b/troubleshooting.rst
index ddf8d1d..f35996d 100644
--- a/troubleshooting.rst
+++ b/troubleshooting.rst
@@ -3,3 +3,5 @@
 ==================
 🐛 Troubleshooting
 ==================
+
+Work in progress 🚧️
diff --git a/usage.rst b/usage.rst
index 5b50c71..cc40164 100644
--- a/usage.rst
+++ b/usage.rst
@@ -5,7 +5,7 @@
 ========
 
 .. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/welcome.png
-    :alt: Welcome to gradience !
+    :alt: Welcome to Gradience!
 
 Gradience is splitted in 3 tabs plus some top level windows.
 
@@ -13,7 +13,7 @@ Colors
 ------
 
 .. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/colors.png
-    :alt: Image of the colors tab
+    :alt: Image of the Colors tab
 
 
 The first tab is the one you see first when you open Gradience and called "Colors" is used for
@@ -40,7 +40,7 @@ Monet
 -----
 
 .. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/monet.png
-    :alt: Image of the monet tab
+    :alt: Image of the Monet tab
 
 Monet is an engine made by Google for creating a color theme from your wallpaper.
 In Gradience, you can either choose to use your wallpaper or to use a custom picture
@@ -65,7 +65,7 @@ Finally, the last tab which is especially designed for an advanced usage. From t
 you can use a custom CSS
 
 .. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/custom_css.png
-    :alt: Custom css
+    :alt: Custom CSS
 
 Or you can use plugins! Plugins are developed by the community for customizing more apps
 like Firefox. They usually require a special setup. You can enable or disable each plugin