From a553f57cb66741cf92442a12eccedf3add05a6f2 Mon Sep 17 00:00:00 2001
From: pennae <github@quasiparticle.net>
Date: Tue, 3 Jan 2023 03:01:45 +0100
Subject: [PATCH] nixos/trezord: convert manual chapter to MD

---
 nixos/modules/services/hardware/trezord.md  | 17 ++++++++
 nixos/modules/services/hardware/trezord.nix |  2 +
 nixos/modules/services/hardware/trezord.xml | 47 +++++++++++----------
 3 files changed, 43 insertions(+), 23 deletions(-)
 create mode 100644 nixos/modules/services/hardware/trezord.md

diff --git a/nixos/modules/services/hardware/trezord.md b/nixos/modules/services/hardware/trezord.md
new file mode 100644
index 000000000000..58c244a44bc1
--- /dev/null
+++ b/nixos/modules/services/hardware/trezord.md
@@ -0,0 +1,17 @@
+# Trezor {#trezor}
+
+Trezor is an open-source cryptocurrency hardware wallet and security token
+allowing secure storage of private keys.
+
+It offers advanced features such U2F two-factor authorization, SSH login
+through
+[Trezor SSH agent](https://wiki.trezor.io/Apps:SSH_agent),
+[GPG](https://wiki.trezor.io/GPG) and a
+[password manager](https://wiki.trezor.io/Trezor_Password_Manager).
+For more information, guides and documentation, see <https://wiki.trezor.io>.
+
+To enable Trezor support, add the following to your {file}`configuration.nix`:
+
+    services.trezord.enable = true;
+
+This will add all necessary udev rules and start Trezor Bridge.
diff --git a/nixos/modules/services/hardware/trezord.nix b/nixos/modules/services/hardware/trezord.nix
index 70c1fd09860e..014ba9164d4e 100644
--- a/nixos/modules/services/hardware/trezord.nix
+++ b/nixos/modules/services/hardware/trezord.nix
@@ -8,6 +8,8 @@ in {
   ### docs
 
   meta = {
+    # Don't edit the docbook xml directly, edit the md and generate it:
+    # `pandoc trezord.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > trezord.xml`
     doc = ./trezord.xml;
   };
 
diff --git a/nixos/modules/services/hardware/trezord.xml b/nixos/modules/services/hardware/trezord.xml
index e1f42bc08294..bf9409c7d634 100644
--- a/nixos/modules/services/hardware/trezord.xml
+++ b/nixos/modules/services/hardware/trezord.xml
@@ -1,26 +1,27 @@
-<chapter xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         version="5.0"
-         xml:id="trezor">
- <title>Trezor</title>
- <para>
-  Trezor is an open-source cryptocurrency hardware wallet and security token
-  allowing secure storage of private keys.
- </para>
- <para>
-  It offers advanced features such U2F two-factor authorization, SSH login
-  through
-  <link xlink:href="https://wiki.trezor.io/Apps:SSH_agent">Trezor SSH agent</link>,
-  <link xlink:href="https://wiki.trezor.io/GPG">GPG</link> and a
-  <link xlink:href="https://wiki.trezor.io/Trezor_Password_Manager">password manager</link>.
-  For more information, guides and documentation, see <link xlink:href="https://wiki.trezor.io"/>.
- </para>
- <para>
-  To enable Trezor support, add the following to your <filename>configuration.nix</filename>:
-<programlisting>
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="trezor">
+  <title>Trezor</title>
+  <para>
+    Trezor is an open-source cryptocurrency hardware wallet and security
+    token allowing secure storage of private keys.
+  </para>
+  <para>
+    It offers advanced features such U2F two-factor authorization, SSH
+    login through
+    <link xlink:href="https://wiki.trezor.io/Apps:SSH_agent">Trezor SSH
+    agent</link>,
+    <link xlink:href="https://wiki.trezor.io/GPG">GPG</link> and a
+    <link xlink:href="https://wiki.trezor.io/Trezor_Password_Manager">password
+    manager</link>. For more information, guides and documentation, see
+    <link xlink:href="https://wiki.trezor.io" role="uri">https://wiki.trezor.io</link>.
+  </para>
+  <para>
+    To enable Trezor support, add the following to your
+    <filename>configuration.nix</filename>:
+  </para>
+  <programlisting>
 services.trezord.enable = true;
 </programlisting>
-  This will add all necessary udev rules and start Trezor Bridge.
- </para>
+  <para>
+    This will add all necessary udev rules and start Trezor Bridge.
+  </para>
 </chapter>