From 4a76783d27d2b44720c20d0bd8d7cb00bd89976c Mon Sep 17 00:00:00 2001
From: Pyrox <pyrox@pyrox.dev>
Date: Wed, 10 Jul 2024 14:47:21 -0400
Subject: [PATCH] add todo page to manual

---
 mkdocs.yml                     |  7 +++++++
 packages/md-manual/TODO.md     | 20 ++++++++++++++++++++
 packages/md-manual/default.nix |  1 +
 packages/md-manual/index.md    |  1 +
 4 files changed, 29 insertions(+)
 create mode 100644 packages/md-manual/TODO.md

diff --git a/mkdocs.yml b/mkdocs.yml
index d2d30be..993b653 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -10,6 +10,7 @@ theme:
   name: material
   favicon: assets/aux-logo.svg
   features:
+    - content.tooltips
     - search.highlight
     - navigation.tabs
     - navigation.indexes
@@ -43,14 +44,20 @@ plugins:
   - search
   - social
 markdown_extensions:
+  - abbr
   - admonition
   - attr_list
+  - pymdownx.betterem
   - pymdownx.details
   - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight
+  - pymdownx.snippets
   - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - tables
 extra:
   social:
     - icon: simple/forgejo
diff --git a/packages/md-manual/TODO.md b/packages/md-manual/TODO.md
new file mode 100644
index 0000000..7e316ae
--- /dev/null
+++ b/packages/md-manual/TODO.md
@@ -0,0 +1,20 @@
+# TODO
+
+Ongoing or future fixups and projects for this documentation site
+
+-   [ ] Fix Nixpkgs documentation admonitions
+
+    -   Currently all of them are broken and need to have their formatting adjusted to be not broken.
+    -   See all the examples [here](https://aux-docs.pyrox.pages.gay/Nixpkgs/library-reference/asserts/), for instance.
+        The code block should be inside the admonition.
+
+-   [ ] Replace Lix doc fixme's with admonitions
+
+    -   Same as above, the current build doesn't allow for the complex replacements that this needs.
+
+-   [ ] Add Lix doc pictures
+
+    -   Currently there are supposed to be images in some places, and they aren't able to be rendered since we don't have them. Make them part of the build.
+
+-   [ ] Add NixOS Options
+    -   Each set of options (`services.forgejo`, `programs.firefox`, etc) should be its own page. A monolithic page is bad for searchability and usability.
diff --git a/packages/md-manual/default.nix b/packages/md-manual/default.nix
index 5df2e27..4361e01 100644
--- a/packages/md-manual/default.nix
+++ b/packages/md-manual/default.nix
@@ -14,6 +14,7 @@ stdenvNoCC.mkDerivation {
   installPhase = ''
     mkdir $out
     cp index.md $out/index.md
+    cp TODO.md $out/TODO.md
     cp -r ${pkgs.amg.manual-assets} $out/assets
     cp -r ${pkgs.amg.nixpkgs-manual} $out/Nixpkgs/
     cp -r ${pkgs.amg.aux-wiki} $out/Aux
diff --git a/packages/md-manual/index.md b/packages/md-manual/index.md
index bb1624f..ae18f51 100644
--- a/packages/md-manual/index.md
+++ b/packages/md-manual/index.md
@@ -16,4 +16,5 @@ We host the following documentation:
     The [Aux Wiki](https://wiki.auxolotl.org), rendered and searchable here, statically. No JS required!
 
 -   [Lix Docs](Lix)
+
     The [Lix Docs](https://docs.lix.systems/manual/lix/nightly/), yet another high-quality resource for those using Nix or Lix.