Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst46
1 files changed, 42 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst
index b22e7c17..6a81bbb0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,43 @@
-.. raw:: html
+archinstall Documentation
+=========================
- <script type="text/javascript">
- window.location.replace('https://archinstall.archlinux.page/');
- </script> \ No newline at end of file
+| **archinstall** is library which can be used to install Arch Linux.
+| The library comes packaged with different pre-configured installers, such as the default :ref:`guided` installer.
+|
+| A demo of the :ref:`guided` installer can be seen here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_.
+
+Some of the features of Archinstall are:
+
+* **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 partially on the installed system.
+
+* **Accessibility friendly** Archinstall works with ``espeakup`` and other accessibility tools thanks to the use of a TUI.
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Running Archinstall
+
+ installing/guided
+
+.. toctree::
+ :maxdepth: 3
+ :caption: Getting help
+
+ help/known_issues
+ help/report_bug
+ help/discord
+
+.. toctree::
+ :maxdepth: 3
+ :caption: Archinstall as a library
+
+ installing/python
+ examples/python
+ archinstall/plugins
+
+.. toctree::
+ :maxdepth: 3
+ :caption: API Reference
+
+ archinstall/Installer