diff --git a/archinstall/__init__.py b/archinstall/__init__.py
index b9a0c2fbee..67230c7138 100644
--- a/archinstall/__init__.py
+++ b/archinstall/__init__.py
@@ -1,6 +1,7 @@
"""Arch Linux installer - guided, templates etc."""
import importlib
import os
+import sys
import time
import traceback
from argparse import ArgumentParser, Namespace
@@ -58,7 +59,7 @@
# For support reasons, we'll log the disk layout pre installation to match against post-installation layout
debug(f"Disk states before installing: {disk.disk_layouts()}")
-if os.getuid() != 0:
+if 'sphinx' not in sys.modules and os.getuid() != 0:
print(_("Archinstall requires root privileges to run. See --help for more."))
exit(1)
diff --git a/archinstall/scripts/list.py b/archinstall/scripts/list.py
new file mode 100644
index 0000000000..0e0363a170
--- /dev/null
+++ b/archinstall/scripts/list.py
@@ -0,0 +1,10 @@
+import glob
+import pathlib
+
+print("The following are viable --script options:")
+
+for script in [pathlib.Path(x) for x in glob.glob(f"{pathlib.Path(__file__).parent}/*.py")]:
+ if script.stem in ['__init__', 'list']:
+ continue
+
+ print(f" {script.stem}")
\ No newline at end of file
diff --git a/docs/_static/style.css b/docs/_static/style.css
new file mode 100644
index 0000000000..579fe077d8
--- /dev/null
+++ b/docs/_static/style.css
@@ -0,0 +1,3 @@
+.wy-nav-content {
+ max-width: none;
+}
\ No newline at end of file
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
new file mode 100644
index 0000000000..b0a4480600
--- /dev/null
+++ b/docs/_templates/layout.html
@@ -0,0 +1,4 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/docs/archinstall/Application.rst b/docs/archinstall/Application.rst
deleted file mode 100644
index c6eb0d4db2..0000000000
--- a/docs/archinstall/Application.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. _archinstall.Application:
-
-archinstall.Application
-=======================
-
-This class enables access to pre-programmed application configurations.
-This is not to be confused with :ref:`archinstall.Profile` which is for pre-programmed profiles for a wider set of installation sets.
-
-
-.. autofunction:: archinstall.Application
diff --git a/docs/archinstall/Profile.rst b/docs/archinstall/Profile.rst
deleted file mode 100644
index a4c1f3bbde..0000000000
--- a/docs/archinstall/Profile.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. _archinstall.Profile:
-
-archinstall.Profile
-===================
-
-This class enables access to pre-programmed profiles.
-This is not to be confused with :ref:`archinstall.Application` which is for pre-programmed application profiles.
-
-Profiles in general is a set or group of installation steps.
-Where as applications are a specific set of instructions for a very specific application.
-
-An example would be the *(currently fictional)* profile called `database`.
-The profile `database` might contain the application profile `postgresql`.
-And that's the difference between :ref:`archinstall.Profile` and :ref:`archinstall.Application`.
-
-.. autofunction:: archinstall.Profile
diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst
deleted file mode 100644
index 970d40f251..0000000000
--- a/docs/archinstall/general.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-.. _archinstall.helpers:
-
-.. warning::
- All these helper functions are mostly, if not all, related to outside-installation-instructions. Meaning the calls will affect your current running system - and not touch your installed system.
-
-Profile related helpers
-=======================
-
-.. autofunction:: archinstall.list_profiles
-
-Packages
-========
-
-.. autofunction:: archinstall.find_package
-
-.. autofunction:: archinstall.find_packages
-
-Locale related
-==============
-
-.. autofunction:: archinstall.list_keyboard_languages
-
-.. autofunction:: archinstall.search_keyboard_layout
-
-.. autofunction:: archinstall.set_keyboard_language
-
-..
- autofunction:: archinstall.Installer.set_keyboard_layout
-
-Services
-========
-
-.. autofunction:: archinstall.service_state
-
-Mirrors
-=======
-
-.. autofunction:: archinstall.filter_mirrors_by_region
-
-.. autofunction:: archinstall.add_custom_mirrors
-
-.. autofunction:: archinstall.insert_mirrors
-
-.. autofunction:: archinstall.use_mirrors
-
-.. autofunction:: archinstall.re_rank_mirrors
-
-.. autofunction:: archinstall.list_mirrors
-
-Disk related
-============
-
-.. autofunction:: archinstall.BlockDevice
-
-.. autofunction:: archinstall.Partition
-
-.. autofunction:: archinstall.Filesystem
-
-.. autofunction:: archinstall.device_state
-
-.. autofunction:: archinstall.all_blockdevices
-
-Luks (Disk encryption)
-======================
-
-.. autofunction:: archinstall.luks2
-
-Networking
-==========
-
-.. autofunction:: archinstall.get_hw_addr
-
-.. autofunction:: archinstall.list_interfaces
-
-.. autofunction:: archinstall.check_mirror_reachable
-
-.. autofunction:: archinstall.update_keyring
-
-.. autofunction:: archinstall.enrich_iface_types
-
-.. autofunction:: archinstall.get_interface_from_mac
-
-.. autofunction:: archinstall.wireless_scan
-
-.. autofunction:: archinstall.get_wireless_networks
-
-General
-=======
-
-.. autofunction:: archinstall.log
-
-.. autofunction:: archinstall.locate_binary
-
-.. autofunction:: archinstall.SysCommand
-
-.. autofunction:: archinstall.SysCommandWorker
-
-Exceptions
-==========
-
-.. autofunction:: archinstall.RequirementError
-
-.. autofunction:: archinstall.DiskError
-
-.. autofunction:: archinstall.ProfileError
-
-.. autofunction:: archinstall.SysCallError
-
-.. autofunction:: archinstall.ProfileNotFound
-
-.. autofunction:: archinstall.HardwareIncompatibilityError
-
-.. autofunction:: archinstall.PermissionError
-
-.. autofunction:: archinstall.UserError
-
-.. autofunction:: archinstall.ServiceException
diff --git a/docs/archinstall/plugins.rst b/docs/archinstall/plugins.rst
new file mode 100644
index 0000000000..898f9006cc
--- /dev/null
+++ b/docs/archinstall/plugins.rst
@@ -0,0 +1,57 @@
+.. _archinstall.Plugins:
+
+Python Plugins
+==============
+
+``archinstall`` supports plugins via two methods.
+
+First method is directly via the ``--plugin`` parameter when running as a CLI tool. This will load a specific plugin locally or remotely via a path.
+
+The second method is via Python's built in `plugin discovery`_ using `entry points`_ categorized as ``archinstall.plugin``.
+
+``--plugin`` parameter
+----------------------
+
+The parameter has the benefit of being stored in the ``--conf`` state, meaning when re-running an installation — the plugin will automatically be loaded.
+It's limitation is that it requires an initial path to be known and written and be cumbersome.
+
+Plugin Discovery
+----------------
+
+This method allows for multiple plugins to be loaded with the drawback that they have to be installed beforehand on the system running ``archinstall``.
+This mainly targets those who build their own ISO's and package specific setups for their needs.
+
+
+What's supported?
+-----------------
+
+Currently the documentation for this is scarse. Until that is resolved, the best way to find supported features is to search the source code for `plugin.on_ `_ as this will give a clear indication of which calls are made to plugins.
+
+How does it work?
+-----------------
+
+``archinstall`` plugins use a discovery-driven approach where plugins are queried for certain functions.
+As an example, if a plugin has the following function:
+
+.. code-block:: python
+
+ def on_pacstrap(*packages):
+ ...
+
+The function :code:`archinstall.Pacman().strap(["some packages"])` is hardcoded to iterate plugins and look for :code:`on_pacstrap` in the plugin.
+If the function exists, :code:`.strap()` will call the plugin's function and replace the initial package list with the result from the plugin.
+
+The best way to document these calls is currently undecided, as it's hard to document this behavior dynamically.
+
+Writing your own?
+-----------------
+
+The simplest way currently is to look at a reference implementation or the community. Two of these are:
+
+* `torxed/archinstall-aur `_
+* `phisch/archinstall-aur `_
+
+And search for `plugin.on_ `_ in the code base to find what ``archinstall`` will look for. PR's are welcome to widen the support for this.
+
+.. _plugin discovery: https://packaging.python.org/en/latest/specifications/entry-points/
+.. _entry points: https://docs.python.org/3/library/importlib.metadata.html#entry-points
\ No newline at end of file
diff --git a/docs/cli_parameters/config/config_options.csv b/docs/cli_parameters/config/config_options.csv
new file mode 100644
index 0000000000..1861b1e1db
--- /dev/null
+++ b/docs/cli_parameters/config/config_options.csv
@@ -0,0 +1,24 @@
+Key,Value(s),Description,Required
+additional-repositories,[ `multilib `_!, `testing `_ ],Enables one or more of the testing and multilib repositories before proceeding with installation,No
+archinstall-language,`lang `__,Sets the TUI language used *(make sure to use the ``lang`` value not the ``abbr``)*,No
+audio_config,`pipewire `_!, `pulseaudio `_,Audioserver to be installed,No
+bootloader,`Systemd-boot `_!, `grub `_,Bootloader to be installed *(grub being mandatory on BIOS machines)*,Yes
+debug,``true``!, ``false``,Enables debug output,No
+disk_config,*Read more under* :ref:`disk config`,Contains the desired disk setup to be used during installation,No
+disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied ontop of ``disk_config``,No
+hostname,``str``,A string definining your machines hostname on the network *(defaults to ``archinstall``)*,No
+kernels,[ `linux `_!, `linux-hardened `_!, `linux-lts `_!, `linux-rt `_!, `linux-rt-lts `_!, `linux-zen `_ ],Defines which kernels should be installed and setup in the boot loader options,Yes
+custom-commands,*Read more under* :ref:`custom commands`,Custom commands that will be run post-install chrooted inside the installed system,No
+locale_config,{kb_layout: `lang `__!, sys_enc: `Character encoding `_!, sys_lang: `locale `_},Defines the keyboard key map!, system encoding and system locale,No
+mirror_config,{custom_mirrors: [ https://... ]!, mirror_regions: { "Worldwide": [ "https://geo.mirror.pkgbuild.com/$repo/os/$arch" ] } },Sets various mirrors *(defaults to ISO's ``/etc/pacman.d/mirrors`` if not defined)*,No
+network_config,*`see options under Network Configuration`*,Sets which type of *(if any)* network configuration should be used,No
+no_pkg_lookups,``true``!, ``false``,Disabled package checking against https://archlinux.org/packages/,No
+ntp,``true``!, ``false``,enables or disables `NTP `_ during installation,No
+offline,``true``!, ``false``,enables or disables certain online checks such as mirror reachability etc,No
+packages,[ !, !, ... ],A list of packages to install during installation,No
+parallel downloads,0-∞,sets a given number of paralell downloads to be used by `pacman `_,No
+profile_config,*`read more under the profiles section`*,Installs a given profile if defined,No
+script,`guided `__! *(default)*!, `minimal `__!, `only_hdd `_!, `swiss `_!, `unattended `_,When used to autorun an installation!, this sets which script to autorun with,No
+silent,``true``!, ``false``,disables or enables user questions using the TUI,No
+swap,``true``!, ``false``,enables or disables swap,No
+timezone,`timezone `_,sets a timezone for the installed system,No
\ No newline at end of file
diff --git a/docs/cli_parameters/config/custom_commands.rst b/docs/cli_parameters/config/custom_commands.rst
new file mode 100644
index 0000000000..c1529020b0
--- /dev/null
+++ b/docs/cli_parameters/config/custom_commands.rst
@@ -0,0 +1,22 @@
+.. _custom commands:
+
+Custom Commands
+===============
+
+| Custom commands is a configuration entry that allows for executing custom commands post-installation.
+| The commands are executed with `arch-chroot `_.
+
+The option takes a list of arguments, an example is:
+
+.. code-block:: json
+
+ {
+ "custom-commands": [
+ "hostname new-hostname"
+ ]
+ }
+
+| The following example will set a new hostname in the installed system.
+| The example is just to illustrate that the command is not run in the ISO but inside the installed system after the base system is installed.
+
+More examples can be found in the code repository under `examples/ `_
\ No newline at end of file
diff --git a/docs/cli_parameters/config/disk_config.rst b/docs/cli_parameters/config/disk_config.rst
new file mode 100644
index 0000000000..ed5f42c17b
--- /dev/null
+++ b/docs/cli_parameters/config/disk_config.rst
@@ -0,0 +1,245 @@
+.. _disk config:
+
+Disk Configuration
+==================
+
+There are only three modes in the ``disk_config`` option. They are described in more detail below.
+
+"Leave as is"
+--------------
+
+.. code-block:: json
+
+ {
+ "config_type": "pre_mounted_config",
+ "mountpoint": "/mnt/archinstall"
+ }
+
+This mode will not perform any partitioning what so ever.
+Instead it relies on what's mounted manually by the user under ``/mnt/archinstall``.
+
+Given the following disk example:
+
+.. code-block::
+
+ /mnt/archinstall (/dev/sda2)
+ ├── boot (/dev/sda1)
+ └── home (/dev/sda3)
+
+Runing ``archinstall --conf your.json --silent`` where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system.
+
+.. note::
+
+ Some disk layouts can be too complicated to detect, such as RAID setups. Please do report those setups on the `Issue Tracker `__ so we can support them.
+
+Best Effort
+-----------
+
+.. warning::
+
+ This mode will wipe data!
+
+.. note::
+
+ Note that this options is similar to the manual partitioning but is generated through the menu system! And the best effort layout might deviate slightly from some wiki guidelines in order to facilitate some optional configurations at a later stage.
+
+.. code-block:: json
+
+ {
+ "disk_config": {
+ "config_type": "default_layout",
+ "device_modifications": [
+ {
+ "device": "/dev/sda",
+ "wipe": true,
+ "partitions": "..."
+ }
+ ]
+ }
+ }
+
+This mode will attempt to configure a sane default layout on the selected disks.
+Based on the chosen filesystem, and potential optional settings for said filesystem — different default layouts will be provided.
+
+Manual Partitioning
+-------------------
+
+.. code-block:: json
+
+ {
+ "disk_config": {
+ "config_type": "manual_partitioning",
+ "device_modifications": [
+ "filesystem struct"
+ ]
+ }
+ }
+
+Manual partitioning is the most complex one of the three. It offers you near endless flexibility of how to partition your disk. It integrates against `pyparted `__ and some control logic in ``archinstall`` that deals with creating things like subvolumes and compression.
+
+Sizes are by default ``sector`` units, but other units are supported.
+
+The options supplied to ``manual_partitioning`` are dictionary definitions, where the following parameters must exist:
+
+.. csv-table:: JSON options
+ :file: ./manual_options.csv
+ :widths: 15, 15, 65, 5
+ :escape: !
+ :header-rows: 1
+
+Each partition definition heavily relies on what filesystem is used.
+Below follow two of the more common filesystems, anything else will best be described by running ``archinstall`` to generate a desired configuration for the desired filesystem type — and copy the relevant parts for permanent configurations.
+
+.. warning::
+
+ Important to note that the units and positions in the examples below — are highly user specific!
+
+FAT32
+^^^^^
+
+.. code-block:: json
+
+ {
+ "btrfs": [],
+ "flags": [
+ "Boot"
+ ],
+ "fs_type": "fat32",
+ "length": {
+ "sector_size": null,
+ "total_size": null,
+ "unit": "B",
+ "value": 99982592
+ },
+ "mount_options": [],
+ "mountpoint": "/boot",
+ "obj_id": "369f31a8-2781-4d6b-96e7-75680552b7c9",
+ "start": {
+ "sector_size": {
+ "sector_size": null,
+ "total_size": null,
+ "unit": "B",
+ "value": 512
+ },
+ "total_size": null,
+ "unit": "sectors",
+ "value": 34
+ },
+ "status": "create",
+ "type": "primary"
+ }
+
+.. note::
+
+ The ``Boot`` flag will make ``archinstall`` automatically set the correct ESP partition GUID if the system is booted with ``EFI`` support. The GUID will then be set to ``C12A7328-F81F-11D2-BA4B-00A0C93EC93B``.
+
+EXT4
+^^^^
+
+.. code-block:: json
+
+ {
+ "btrfs": [],
+ "flags": [],
+ "fs_type": "ext4",
+ "length": {
+ "sector_size": null,
+ "total_size": null,
+ "unit": "B",
+ "value": 15805127360
+ },
+ "mount_options": [],
+ "mountpoint": "/",
+ "obj_id": "3e75d045-21a4-429d-897e-8ec19a006e8b",
+ "start": {
+ "sector_size": {
+ "sector_size": null,
+ "total_size": null,
+ "unit": "B",
+ "value": 512
+ },
+ "total_size": {
+ "sector_size": null,
+ "total_size": null,
+ "unit": "B",
+ "value": 16106127360
+ },
+ "unit": "MB",
+ "value": 301
+ },
+ "status": "create",
+ "type": "primary"
+ }
+
+BTRFS
+^^^^^
+
+The BTRFS filesystem is inherently more complicated, thus the options are a bit more involved.
+This example contains both subvolumes and compression.
+
+.. note::
+
+ Note that the ``"mountpoint": null`` is used for the overall partition, and instead individual subvolumes have mountpoints set.
+
+.. code-block:: json
+
+ {
+ "btrfs": [
+ {
+ "compress": false,
+ "mountpoint": "/",
+ "name": "@",
+ "nodatacow": false
+ },
+ {
+ "compress": false,
+ "mountpoint": "/home",
+ "name": "@home",
+ "nodatacow": false
+ },
+ {
+ "compress": false,
+ "mountpoint": "/var/log",
+ "name": "@log",
+ "nodatacow": false
+ },
+ {
+ "compress": false,
+ "mountpoint": "/var/cache/pacman/pkg",
+ "name": "@pkg",
+ "nodatacow": false
+ },
+ {
+ "compress": false,
+ "mountpoint": "/.snapshots",
+ "name": "@.snapshots",
+ "nodatacow": false
+ }
+ ],
+ "dev_path": null,
+ "flags": [],
+ "fs_type": "btrfs",
+ "mount_options": [
+ "compress=zstd"
+ ],
+ "mountpoint": null,
+ "obj_id": "d712357f-97cc-40f8-a095-24ff244d4539",
+ "size": {
+ "sector_size": {
+ "unit": "B",
+ "value": 512
+ },
+ "unit": "B",
+ "value": 15568207872
+ },
+ "start": {
+ "sector_size": {
+ "unit": "B",
+ "value": 512
+ },
+ "unit": "MiB",
+ "value": 513
+ },
+ "status": "create",
+ "type": "primary"
+ }
\ No newline at end of file
diff --git a/docs/cli_parameters/config/disk_encryption.rst b/docs/cli_parameters/config/disk_encryption.rst
new file mode 100644
index 0000000000..df2e2fa7b7
--- /dev/null
+++ b/docs/cli_parameters/config/disk_encryption.rst
@@ -0,0 +1,19 @@
+.. _disk encryption:
+
+Disk Encryption
+===============
+
+Disk encryption consists of a top level entry in the user configuration.
+
+.. code-block:: json
+
+ {
+ "disk_encryption": {
+ "encryption_type": "luks",
+ "partitions": [
+ "d712357f-97cc-40f8-a095-24ff244d4539"
+ ]
+ }
+ }
+
+The ``UID`` in the ``partitions`` list is an internal reference to the ``obj_id`` in the :ref:`disk config` entries.
\ No newline at end of file
diff --git a/docs/cli_parameters/config/manual_options.csv b/docs/cli_parameters/config/manual_options.csv
new file mode 100644
index 0000000000..2fcc26f0c9
--- /dev/null
+++ b/docs/cli_parameters/config/manual_options.csv
@@ -0,0 +1,4 @@
+Key,Value(s),Description,Required
+device,``str``,Which block-device to format,yes
+partitions,[ {key: val} ],The data describing the change/addition in a partition,yes
+wipe,``bool``,clear the disk before adding any partitions,No
\ No newline at end of file
diff --git a/docs/examples/binary.rst b/docs/examples/binary.rst
deleted file mode 100644
index 51dbd1dd39..0000000000
--- a/docs/examples/binary.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. _examples.binary:
-
-Binary executable
-=================
-
-.. warning:: The binary option is limited and stiff. It's hard to modify or create your own installer-scripts this way unless you compile the source manually. If your usecase needs custom scripts, either use the pypi setup method or you'll need to adjust the PKGBUILD prior to building the arch package.
-
-The binary executable is a standalone compiled version of the library.
-It's compiled using `nuitka `_ with the flag `--standalone`.
-
-Executing the binary
---------------------
-
-As an example we'll use the `guided `_ installer.
-To run the `guided` installed, all you have to do *(after installing or compiling the binary)*, is run:
-
-
-.. code-block:: console
-
- ./archinstall guided
-
-As mentioned, the binary is a bit rudimentary and only supports executing whatever is found directly under `./archinstall/examples`.
-Anything else won't be found. This is subject to change in the future to make it a bit more flexible.
diff --git a/docs/examples/python.rst b/docs/examples/python.rst
index b5478fe217..7fb3f6c3d5 100644
--- a/docs/examples/python.rst
+++ b/docs/examples/python.rst
@@ -4,7 +4,7 @@ Python module
=============
Archinstall supports running in `module mode `_.
-The way the library is invoked in module mode is limited to executing scripts under the **example** folder.
+The way the library is invoked in module mode is limited to executing scripts under the `scripts`_ folder.
It's therefore important to place any script or profile you wish to invoke in the examples folder prior to building and installing.
@@ -12,7 +12,7 @@ Pre-requisites
--------------
We'll assume you've followed the :ref:`installing.python.manual` method.
-Before actually installing the library, you will need to place your custom installer-scripts under `./archinstall/examples/` as a python file.
+Before actually installing the library, you will need to place your custom installer-scripts under `scripts`_ as a python file.
More on how you create these in the next section.
@@ -24,36 +24,73 @@ Creating a script
-----------------
Lets create a `test_installer` - installer as an example. This is assuming that the folder `./archinstall` is a git-clone of the main repo.
-We begin by creating `./archinstall/examples/test_installer.py`. The placement here is important later.
+We begin by creating "`scripts`_:code:`/test_installer.py`". The placement here is important later.
-This script can now already be called using `python -m archinstall test_installer` after a successful installation of the library itself.
+This script can now already be called using :code:`python -m archinstall test_installer` after a successful installation of the library itself.
But the script won't do much. So we'll do something simple like list all the hard drives as an example.
-To do this, we'll begin by importing `archinstall` in our `./archinstall/examples/test_installer.py` and call some functions.
+To do this, we'll begin by importing :code:`archinstall` in our "`scripts`_:code:`/test_installer.py`" and call a function whtin ``archinstall``.
.. code-block:: python
import archinstall
- all_drives = archinstall.all_blockdevices(partitions=False)
- print(list(all_drives.keys()))
+ print(archinstall.disk.device_handler.devices)
+
+Now, go ahead and reference the :ref:`installing.python.manual` installation method.
+After runnig ``python -m archinstall test_installer`` it should print something that looks like:
+
+.. code-block:: text
+
+ [
+ BDevice(
+ disk=,
+ device_info=_DeviceInfo(
+ model='PC801 NVMe SK hynix 512GB',
+ path=PosixPath('/dev/nvme0n1'),
+ type='nvme',
+ total_size=Size(value=512110190592, unit=,
+ sector_size=SectorSize(value=512, unit=)),
+ free_space_regions=[
+ ,
+ ,
+ ],
+ sector_size=SectorSize(value=512, unit=),
+ read_only=False,
+ dirty=False
+ ),
+ partition_infos=[
+ _PartitionInfo(
+ partition=,
+ name='primary',
+ type=,
+ fs_type=,
+ path='/dev/nvme0n1p1',
+ start=Size(value=2048, unit=, sector_size=SectorSize(value=512, unit=)),
+ length=Size(value=535822336, unit=, sector_size=SectorSize(value=512, unit=)),
+ flags=[
+ ,
+
+ ],
+ partn=1,
+ partuuid='a26be943-c193-41f4-9930-9341cf5f6b19',
+ uuid='6EE9-2C00',
+ disk=,
+ mountpoints=[
+ PosixPath('/boot')
+ ],
+ btrfs_subvol_infos=[]
+ ),
+ _PartitionInfo(...)
+ ]
+ )
+ ]
+
+That means your script is in the right place, and ``archinstall`` is working as intended.
-This should print out a list of drives and some meta-information about them.
-As an example, this will do just fine.
-
-Now, go ahead and install the library either as a user-module or system-wide.
-
-Calling a module
-----------------
-
-Assuming you've followed the example in `Creating a script`_, you can now safely call it with:
-
-.. code-block:: console
-
- python -m archinstall test_installer
+.. note::
-This should now print all available drives on your system.
+ Most calls, including the one above requires `root `_ privileges.
-.. note::
- This should work on any system, not just Arch Linux based ones. But note that other functions in the library rely heavily on Arch Linux based commands to execute the installation steps. Such as `arch-chroot`.
+.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
\ No newline at end of file
diff --git a/docs/help/known_issues.rst b/docs/help/known_issues.rst
new file mode 100644
index 0000000000..2f1f62cbf3
--- /dev/null
+++ b/docs/help/known_issues.rst
@@ -0,0 +1,103 @@
+.. _help.known_issues:
+
+Known Issues
+============
+
+| Some issues are out of the `archinstall`_ projects scope, and the ones we know of are listed below.
+
+.. _waiting for time sync:
+
+Waiting for time sync `#2144`_
+------------------------------
+
+| The usual root cause of this is the network topology.
+| More specifically `timedatectl show`_ cannot perform a proper time sync against the default servers.
+
+| A *"fix"* for this is mentioned in the issue above.
+| That is to configure ``/etc/systemd/timesyncd.conf`` and restart ``systemd-timesyncd.service``.
+
+.. note::
+
+ A proposal to override the time sync check has been put up for discussion in `#2144`_.
+
+Missing Nvidia Proprietary Driver `#2002`_
+------------------------------------------
+
+| In some instances, the nvidia driver might not have all the nessecary packages installed.
+| This is due to the kernel selection and/or hardware setups requiring additional packages to work properly.
+
+A common workaround is to install the package `linux-headers`_ and `nvidia-dkms`_
+
+ARM, 32bit and other CPU types error out `#1686`_, `#2185`_
+-----------------------------------------------------------
+
+| This is a bit of a catch-all known issue.
+| Officially `x86_64`_ is only supported by Arch Linux.
+| Hence little effort have been put into supporting other platforms.
+
+| In theory, other architectures should work but small quirks might arise.
+
+| PR's are welcome but please be respectful of the delays in merging.
+| Other fixes, issues or features will be prioritized for the above reasons.
+
+Keyring is out of date `#2213`_
+-------------------------------
+
+| Missing key-issues tend to be that the `archlinux-keyring`_ package is out of date, usually as a result of an outdated ISO.
+| There is an attempt from upstream to fix this issue, and it's the `archlinux-keyring-wkd-sync.service`_
+
+| The service starts almost immediately during boot, and if network is not configured in time — the service will fail.
+| Subsequently the ``archinstall`` run might operate on a old keyring despite there being an update service for this.
+
+| There is really no way to reliably over time work around this issue in ``archinstall``.
+| Instead, efforts to the upstream service should be considered the way forward. And/or keys not expiring betwene a sane ammount of ISO's.
+
+.. note::
+
+ The issue can happen on new ISO's too even as little as a few days after release, as some keys might expire right after the keyring is *"burnt in"* to the ISO.
+
+.. note::
+
+ Another common issue relating to the network not being configured, is that time might not be set correctly - resulting in the keyring not being able to update. See :ref:`waiting for time sync`.
+
+AUR packages
+------------
+
+| This is also a catch-all issue.
+| `AUR is unsupported `_, and until that changes we cannot use AUR packages to solve feature requests in ``archinstall``.
+
+| This means that feature requests like supporting filesystems such as `ZFS`_ can not be added, and issues cannot be solved by using AUR packages either.
+
+.. note::
+
+ But in spirit of giving the community options, ``archinstall`` supports :ref:`archinstall.Plugins`, which means you can run ``archinstall --plugin `` and source an AUR plugin.
+
+ `torxed/archinstall-aur `_ is a reference implementation for plugins:
+
+ .. code-block:: console
+
+ # archinstall --plugin https://archlinux.life/aur-plugin
+
+ `phisch/archinstall-aur `_ is another alternative:
+
+ .. code-block:: console
+
+ # archinstall --plugin https://raw.githubusercontent.com/phisch/archinstall-aur/master/archinstall-aur.py
+
+ .. warning::
+
+ This will allow for unsupported usage of AUR during installation.
+
+.. _#2213: https://github.com/archlinux/archinstall/issues/2213
+.. _#2185: https://github.com/archlinux/archinstall/issues/2185
+.. _#2144: https://github.com/archlinux/archinstall/issues/2144
+.. _#2002: https://github.com/archlinux/archinstall/issues/2002
+.. _#1686: https://github.com/archlinux/archinstall/issues/1686
+.. _linux-headers: https://archlinux.org/packages/core/x86_64/linux-headers/
+.. _nvidia-dkms: https://archlinux.org/packages/extra/x86_64/nvidia-dkms/
+.. _x86_64: https://wiki.archlinux.org/title/Frequently_asked_questions#What_architectures_does_Arch_support?
+.. _archlinux-keyring: https://archlinux.org/packages/core/any/archlinux-keyring/
+.. _archlinux-keyring-wkd-sync.service: https://gitlab.archlinux.org/archlinux/archlinux-keyring/-/blob/7e672dad10652a80d1cc575d75cdb46442cd7f96/wkd_sync/archlinux-keyring-wkd-sync.service.in
+.. _ZFS: https://aur.archlinux.org/packages/zfs-linux
+.. _archinstall: https://github.com/archlinux/archinstall/
+.. _timedatectl show: https://github.com/archlinux/archinstall/blob/e6344f93f7e476d05bbcd642f2ed91fdde545870/archinstall/lib/installer.py#L136
\ No newline at end of file
diff --git a/docs/help/issues.rst b/docs/help/report_bug.rst
similarity index 98%
rename from docs/help/issues.rst
rename to docs/help/report_bug.rst
index 7d690b654f..bd0ac50a2b 100644
--- a/docs/help/issues.rst
+++ b/docs/help/report_bug.rst
@@ -1,6 +1,6 @@
.. _help.issues:
-Issue tracker & bugs
+Report Issues & Bugs
====================
Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues `_.
diff --git a/docs/index.rst b/docs/index.rst
index a76a58d642..6a81bbb009 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
diff --git a/docs/installing/binary.rst b/docs/installing/binary.rst
deleted file mode 100644
index eeb9d79d39..0000000000
--- a/docs/installing/binary.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-.. _installing.binary:
-
-Binary executable
-=================
-
-Archinstall can be compiled into a standalone executable.
-For Arch Linux based systems, there's a package for this called `archinstall `_.
-
-.. warning::
- This is not required if you're running archinstall on a pre-built ISO. The installation is only required if you're creating your own scripted installations.
-
-Using pacman
-------------
-
-Archinstall is on the `official repositories `_.
-
-.. code-block:: console
-
- sudo pacman -S archinstall
-
-Using PKGBUILD
---------------
-
-The `source `_ contains a binary `PKGBUILD `_ which can be either copied straight off the website or cloned using :code:`git clone https://github.com/Torxed/archinstall`.
-
-Once you've obtained the `PKGBUILD`, building it is pretty straight forward.
-
-.. code-block:: console
-
- makepkg -s
-
-Which should produce an `archinstall-X.x.z-1.pkg.tar.zst` which can be installed using:
-
-.. code-block:: console
-
- sudo pacman -U archinstall-X.x.z-1.pkg.tar.zst
-
-.. note::
-
- For a complete guide on the build process, please consult the `PKGBUILD on ArchWiki `_.
-
-Manual compilation
-------------------
-
-You can compile the source manually without using a custom mirror or the `PKGBUILD` that is shipped.
-Simply clone or download the source, and while standing in the cloned folder `./archinstall`, execute:
-
-.. code-block:: console
-
- nuitka3 --standalone --show-progress archinstall
-
-This requires the `nuitka `_ package as well as `python3` to be installed locally.
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index c5e7f1ed65..dcedfc105a 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -3,20 +3,16 @@
Guided installation
===================
-| This is the default script the Arch Linux `Archinstall package `_.
-| It will guide you through a very basic installation of Arch Linux.
+Archinstall ships with a pre-programmed `Guided Installer`_ guiding you through the mandatory steps as well as some optional configurations that can be done.
.. note::
- There are other scripts and they can be invoked by executing `archinstall