add todo page to manual

This commit is contained in:
Pyrox 2024-07-10 14:47:21 -04:00
parent 3355ffcbf9
commit 4a76783d27
Signed by: pyrox
GPG key ID: 8CDF3F7CAA53A0F5
4 changed files with 29 additions and 0 deletions

View file

@ -10,6 +10,7 @@ theme:
name: material name: material
favicon: assets/aux-logo.svg favicon: assets/aux-logo.svg
features: features:
- content.tooltips
- search.highlight - search.highlight
- navigation.tabs - navigation.tabs
- navigation.indexes - navigation.indexes
@ -43,14 +44,20 @@ plugins:
- search - search
- social - social
markdown_extensions: markdown_extensions:
- abbr
- admonition - admonition
- attr_list - attr_list
- pymdownx.betterem
- pymdownx.details - pymdownx.details
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight - pymdownx.highlight
- pymdownx.snippets
- pymdownx.superfences - pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- tables
extra: extra:
social: social:
- icon: simple/forgejo - icon: simple/forgejo

View file

@ -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.

View file

@ -14,6 +14,7 @@ stdenvNoCC.mkDerivation {
installPhase = '' installPhase = ''
mkdir $out mkdir $out
cp index.md $out/index.md cp index.md $out/index.md
cp TODO.md $out/TODO.md
cp -r ${pkgs.amg.manual-assets} $out/assets cp -r ${pkgs.amg.manual-assets} $out/assets
cp -r ${pkgs.amg.nixpkgs-manual} $out/Nixpkgs/ cp -r ${pkgs.amg.nixpkgs-manual} $out/Nixpkgs/
cp -r ${pkgs.amg.aux-wiki} $out/Aux cp -r ${pkgs.amg.aux-wiki} $out/Aux

View file

@ -16,4 +16,5 @@ We host the following documentation:
The [Aux Wiki](https://wiki.auxolotl.org), rendered and searchable here, statically. No JS required! The [Aux Wiki](https://wiki.auxolotl.org), rendered and searchable here, statically. No JS required!
- [Lix Docs](Lix) - [Lix Docs](Lix)
The [Lix Docs](https://docs.lix.systems/manual/lix/nightly/), yet another high-quality resource for those using Nix or Lix. The [Lix Docs](https://docs.lix.systems/manual/lix/nightly/), yet another high-quality resource for those using Nix or Lix.