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:
authorAnton Hvornum <anton@hvornum.se>2023-11-21 14:34:30 +0100
committerGitHub <noreply@github.com>2023-11-21 14:34:30 +0100
commitcc806d9c4ce29212c2848c15b4b184feace3e1ac (patch)
tree28f4f1cb3b943d178a07a37369d3133093c51e17 /docs/index.rst
parente6344f93f7e476d05bbcd642f2ed91fdde545870 (diff)
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
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst38
1 files changed, 6 insertions, 32 deletions
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