From cc806d9c4ce29212c2848c15b4b184feace3e1ac Mon Sep 17 00:00:00 2001
From: Anton Hvornum <anton@hvornum.se>
Date: Tue, 21 Nov 2023 14:34:30 +0100
Subject: Started a re-write of the docs (#1967)

* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions

* Added final config options in --config, some have external references which needs to be populated

* Forgot to escape a comma

* Clarified a note

* Added disk configuration and disk encryption docs

* Changed way of installing using source and python

* Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options.

* Added a 'Known issues' section, as well as renamed the issues tab

* Finished up the known issues section

* Added a section regarding --plugin

* Added plugin description, tweaked disk_config to the latest changes from #2221

* Added custom-commands docs, and improved some creds and known issue links
---
 docs/index.rst | 38 ++++++--------------------------------
 1 file changed, 6 insertions(+), 32 deletions(-)

(limited to 'docs/index.rst')

diff --git a/docs/index.rst b/docs/index.rst
index a76a58d6..6a81bbb0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,17 +8,15 @@ archinstall Documentation
 
 Some of the features of Archinstall are:
 
-* **No external dependencies or installation requirements.** Runs without any external requirements or installation processes.
-
 * **Context friendly.** The library always executes calls in sequential order to ensure installation-steps don't overlap or execute in the wrong order. It also supports *(and uses)* context wrappers to ensure cleanup and final tasks such as ``mkinitcpio`` are called when needed.
 
-* **Full transparency** Logs and insights can be found at ``/var/log/archinstall`` both in the live ISO and the installed system.
+* **Full transparency** Logs and insights can be found at ``/var/log/archinstall`` both in the live ISO and partially on the installed system.
 
 * **Accessibility friendly** Archinstall works with ``espeakup`` and other accessibility tools thanks to the use of a TUI.
 
 .. toctree::
-   :maxdepth: 3
-   :caption: Running the installer
+   :maxdepth: 1
+   :caption: Running Archinstall
 
    installing/guided
 
@@ -26,8 +24,9 @@ Some of the features of Archinstall are:
    :maxdepth: 3
    :caption: Getting help
 
+   help/known_issues
+   help/report_bug
    help/discord
-   help/issues
 
 .. toctree::
    :maxdepth: 3
@@ -35,35 +34,10 @@ Some of the features of Archinstall are:
 
    installing/python
    examples/python
-
-.. toctree::
-   :maxdepth: 3
-   :caption: Archinstall as a binary
-
-   installing/binary
-   examples/binary
-..
-   examples/scripting
-
-..
-   .. toctree::
-   :maxdepth: 3
-   :caption: Programming Guide
-
-..
-   programming_guide/requirements
-   programming_guide/basic_concept
+   archinstall/plugins
 
 .. toctree::
    :maxdepth: 3
    :caption: API Reference
 
    archinstall/Installer
-   archinstall/Profile
-   archinstall/Application
-
-.. toctree::
-   :maxdepth: 3
-   :caption: API Helper functions
-
-   archinstall/general
-- 
cgit v1.2.3-70-g09d2