doc: nested list indentation

README.md

@@ -44,11 +44,11 @@ are allowed to make.
 Here are some of the Global Preferences we can manage:
 
 - **clockvm**: disp-sys-net, sys-net
+- **default_audiovm**: disp-sys-audio
 - **default_dispvm**: dvm-reader
 - **default_netvm**: sys-pihole, sys-firewall or disp-sys-firewall
 - **management_dispvm**: dvm-mgmt
 - **updatevm**: sys-pihole, sys-firewall or disp-sys-firewall
-- **default_audiovm**: disp-sys-audio
 
 If you want to learn more about how we make decisions, take a look at our
 [design document](docs/DESIGN.md).
@@ -67,12 +67,12 @@ You current setup needs to fulfill the following requisites:
 1.  Install `git` in the qube, if it is an AppVM, install it it's the
     TemplateVM and restart the AppVM.
 
-2. Clone this repository:
+2.  Clone the repository (if you made a fork, fork the submodule(s) before
+    clone and use your remote repository instead, the submodules will also be
+    from your fork).
     ```sh
     git clone --recurse-submodules https://github.com/ben-grande/qusal.git
     ```
-  If you made a fork, fork the submodule(s) before clone and use your remote
-  repository instead, the submodules will also be from your fork.
 
 3.  Copy the [maintainer's signing key](https://github.com/ben-grande/ben-grande/raw/main/DF3834875B65758713D93E91A475969DE4E371E3.asc)
     to your text editor and save the file to `/home/user/ben-code.asc`.
@@ -147,7 +147,7 @@ with the sys-git formula.
 1.  Install the [sys-git formula](salt/sys-git/README.md) and push the
     repository to the git server.
 
-2. Install git on Dom0, allow the Qrexec protocol to work in submodules and
+2.  Install `git` on Dom0, allow the Qrexec protocol to work in submodules and
     clone the repository to `~/src/qusal` (only has to be run once):
     ```sh
     mkdir -p ~/src

docs/CONTRIBUTING.md

@@ -18,7 +18,7 @@ Be respectful towards peers.
 ## Environment
 
 You will need to setup you development environment before you start
-contributing. You will need Qubes OS R4 or higher.
+contributing.
 
 ### Requirements
 

docs/DESIGN.md

@@ -39,26 +39,21 @@ No extraneous features should be included by default besides the basic for
 functionality. Extra functionalities that could weaken the system can be
 provided via extra states that needs to be installed per the user discretion.
 
+## Documentation
+
+Markdown code must follow
+[Google's Markdown style guide](https://google.github.io/styleguide/docguide/style.html).
+Any discrepancies with Google's style guide must be fixed or documented here
+with clear motive.
+
+Documentation must not duplicate itself, but reference one another.
+Reproducing instructions that can be found in upstream documentation is
+discouraged unless the benefits of documenting it in-house, such as getting
+the documentation from a single source, do outweigh the necessity of having to
+modify the documentation constantly to keep up with upstream.
+
 ## Format
 
-### File naming
-
-1. Every State file `.sls` must have a Top file `.top`. This ensures that
-   every state can be applied with top.
-2. Every project must have a `init.top`, it facilitates applying every state
-   by enabling a single top file.
-3. State file naming must be common between the projects, it helps
-   understand the project as if it was any other.
-4. File name must use `-` as separator, not `_`.
-
-### State ID
-
-1. State IDs must use `-` as separator, not `_`. The underline is allowed in
-   case the features it is changing has underline, such as `default_netvm`.
-2. State IDs must always have the project ID, thus allowing to target multiple
-   states to the same minion from different projects without having
-   conflicting IDs.
-
 ### Readme
 
 Every project should have a README.md with at least the following sections:
@@ -70,6 +65,24 @@ Every project should have a README.md with at least the following sections:
 - Usage; and
 - Credits (if sourced).
 
+### File naming
+
+1.  Every State file `.sls` must have a Top file `.top`. This ensures that
+    every state can be applied with top.
+2.  Every project must have a `init.top`, it facilitates applying every state
+    by enabling a single top file.
+3.  State file naming must be common between the projects, it helps understand
+    the project as if it was any other.
+4.  File name must use `-` as separator, not `_`.
+
+### State ID
+
+1.  State IDs must use `-` as separator, not `_`. The underline is allowed in
+    case the features it is changing has underline, such as `default_netvm`.
+2.  State IDs must always have the project ID, thus allowing to target multiple
+    states to the same minion from different projects without having
+    conflicting IDs.
+
 ### Qube preferences
 
 #### Qube naming
@@ -101,14 +114,14 @@ related to trustworthiness of the data it is dealing with.
 
 -   **Black**:
     -   **Trust**: Ultimate.
-  - **Description**: You must trust Dom0, Templates, Vaults, Management qubes,
-    these qubes control your system and hold valuable information.
+    -   **Description**: You must trust Dom0, Templates, Vaults, Management
+        qubes, these qubes control your system and hold valuable information.
     -   **Examples**: dom0, tpl-ssh, vault, dvm-mgmt.
 -   **Gray**:
     -   **Trust**: Fully.
-  - **Description**: Trusted storage with extra RPC services that allow certain
-    operations to be made by the client and executed on the server or may
-    build components for other qubes.
+    -   **Description**: Trusted storage with extra RPC services that allow
+        certain operations to be made by the client and executed on the server
+        or may build components for other qubes.
     -   **Examples**: sys-cacher, sys-git, sys-pgp, sys-ssh-agent, qubes-builder.
 -   **Purple**:
   -   **Trust**: Very much.
@@ -129,13 +142,13 @@ related to trustworthiness of the data it is dealing with.
     -   **Examples**: TODO
 -   **Orange**:
     -   **Trust**: Slight.
-  - **Description**: Controls the network flow of data to the client, normally a
-    firewall.
+    -   **Description**: Controls the network flow of data to the client,
+        normally a firewall.
     -   **Examples**: sys-firewall, sys-vpn, sys-pihole.
 -   **Red**:
     -   **Trust**: Untrusted.
-  - **Description**: Holds untrusted data (PCI devices, untrusted programs,
-    disposables for opening untrusted files or web pages).
+    -   **Description**: Holds untrusted data (PCI devices, untrusted
+        programs, disposables for opening untrusted files or web pages).
     -   **Examples**: sys-net, sys-usb, dvm-browser.
 
 ### Qube connections
@@ -150,9 +163,9 @@ Xen or with Qrexec. If something is not required, we remove it.
   -   When required, set it to `"*default*"` to honor the global preferences.
   -   When not required, must be set to None;
 -   `netvm` is required on a lot of projects.
-  - When required, must not be managed to honor the global preferences. If it
-    requires a custom networking scheme, the state must make sure that the
-    netvm exists;
+  -   When required, must not be managed to honor the global preferences. If
+      it requires a custom networking scheme, the state must make sure that
+      the netvm exists;
   -   When not required, must be set to None.
 -   `default_dispvm` is nice to have:
   -  When required, must guarantee that the network follows the same chain as

salt/browser/README.md

@@ -21,7 +21,7 @@ Firefox-ESR, W3M or Lynx.
 
 ## Installation
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable browser
 sudo qubesctl --targets=tpl-browser,dvm-browser state.apply
@@ -29,7 +29,7 @@ sudo qubesctl top.disable browser
 sudo qubesctl state.apply browser.appmenus
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply browser.create

salt/dom0/README.md

@@ -15,14 +15,14 @@ etc.
 
 ## Installation
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable dom0
 sudo qubesctl state.apply
 sudo qubesctl top.disable dom0
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply dom0

salt/dotfiles

@@ -1 +1 @@
-Subproject commit 84bae87dc5da48334f81501e11cf17919ff1504b
+Subproject commit 0dd49bcab48ddb7c328e1320c875780b2d9db1bc

salt/mail/README.md

@@ -74,7 +74,7 @@ exploitation, as `msmtp` still needs to parse the mail to be sent.
 
 ## Installation
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable mail reader
 sudo qubesctl --targets=tpl-mail-fetcher,tpl-mail-reader,tpl-mail-sender,dvm-mail-fetcher,mail-reader,dvm-mail-sender,tpl-reader state.apply
@@ -82,7 +82,7 @@ sudo qubesctl top.disable mail reader
 sudo qubesctl state.apply mail.appmenus,reader.appmenus
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply mail.create

salt/mirage-builder/README.md

@@ -21,14 +21,14 @@ are done through the web interface, they have GitHub Web-Flow signature. This
 is the best verification we can get for Mirage Firewall. If you don't trust
 the hosting provider however, don't install this package.
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable mirage-builder
 sudo qubesctl --targets=tpl-mirage-builder,mirage-builder state.apply
 sudo qubesctl top.disable mirage-builder
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply mirage-builder.create

salt/sys-electrs/README.md

@@ -26,14 +26,14 @@ At least `200GB` of disk space is required.
 
 This formula depends on [sys-bitcoin](../sys-bitcoin/README.md).
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable sys-electrs
 sudo qubesctl --targets=tpl-electrs-builder,tpl-sys-electrs,disp-electrs-builder,sys-electrs state.apply
 sudo qubesctl top.disable sys-electrs
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply sys-electrs.create

salt/sys-mirage-firewall/README.md

@@ -26,14 +26,14 @@ You can't use Mirage Firewall to be the updatevm, use another qube instead.
 We have built the Unikernel locally and verified that the upstream checksum
 and local checksum matched when comparing the same release.
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable sys-mirage-firewall
 sudo qubesctl state.apply
 sudo qubesctl top.disable sys-mirage-firewall
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl state.apply sys-mirage-firewall.create

salt/sys-pihole/README.md

@@ -68,6 +68,7 @@ Pi-hole will be installed with these default settings:
 - Query logging is enabled to show everything.
 
 You can change the settings via the admin interface:
+
 - URL: http://localhost/admin
 - There is no password (access allowed only through localhost)
 

salt/utils/tools/zsh/README.md

@@ -15,14 +15,14 @@ warnings.
 
 ## Installation
 
-- Top
+- Top:
 ```sh
 sudo qubesctl top.enable utils.tools.zsh
 sudo qubesctl --targets=TARGET state.apply
 sudo qubesctl top.disable utils.tools.zsh
 ```
 
-- State
+- State:
 <!-- pkg:begin:post-install -->
 ```sh
 sudo qubesctl --skip-dom0 --targets=TEMPLATEVMS state.apply utils.tools.zsh.change-shell