From efcf57232e924c4fdaef5466a7a2bfd01a82644a Mon Sep 17 00:00:00 2001 From: isabel Date: Tue, 31 Dec 2024 22:52:10 +0000 Subject: [PATCH] docs: init --- .github/TODO.md | 5 - .github/workflows/check.yml | 1 + .github/workflows/docs.yml | 48 +++++ .github/workflows/generate-topology.yml | 2 +- README.md | 203 +------------------- docs/book.toml | 19 ++ docs/src/README.md | 0 docs/src/SUMMARY.md | 20 ++ docs/src/config/adding-systems.md | 36 ++++ docs/src/config/adding-users.md | 4 + docs/src/config/installation.md | 64 ++++++ docs/src/config/layout.md | 21 ++ docs/src/config/shortcuts.md | 12 ++ docs/src/config/templates.md | 6 + docs/src/further-reading.md | 43 +++++ {.github => docs/src}/images/blur.png | Bin {.github => docs/src}/images/blur.webp | Bin {.github => docs/src}/images/lightmode.png | Bin {.github => docs/src}/images/lightmode.webp | Bin {.github => docs/src}/images/main.png | Bin {.github => docs/src}/images/main.webp | Bin {.github => docs/src}/images/nvim.png | Bin {.github => docs/src}/images/nvim.webp | Bin {.github => docs/src}/images/topology.png | Bin docs/src/misc/previews.md | 5 + parts/packages/default.nix | 2 + parts/packages/docs.nix | 61 ++++++ 27 files changed, 345 insertions(+), 207 deletions(-) delete mode 100644 .github/TODO.md create mode 100644 .github/workflows/docs.yml create mode 100644 docs/book.toml create mode 100644 docs/src/README.md create mode 100644 docs/src/SUMMARY.md create mode 100644 docs/src/config/adding-systems.md create mode 100644 docs/src/config/adding-users.md create mode 100644 docs/src/config/installation.md create mode 100644 docs/src/config/layout.md create mode 100644 docs/src/config/shortcuts.md create mode 100644 docs/src/config/templates.md create mode 100644 docs/src/further-reading.md rename {.github => docs/src}/images/blur.png (100%) rename {.github => docs/src}/images/blur.webp (100%) rename {.github => docs/src}/images/lightmode.png (100%) rename {.github => docs/src}/images/lightmode.webp (100%) rename {.github => docs/src}/images/main.png (100%) rename {.github => docs/src}/images/main.webp (100%) rename {.github => docs/src}/images/nvim.png (100%) rename {.github => docs/src}/images/nvim.webp (100%) rename {.github => docs/src}/images/topology.png (100%) create mode 100644 docs/src/misc/previews.md create mode 100644 parts/packages/docs.nix diff --git a/.github/TODO.md b/.github/TODO.md deleted file mode 100644 index d0286bc3..00000000 --- a/.github/TODO.md +++ /dev/null @@ -1,5 +0,0 @@ -- [x] look into syncthing over nextcloud -- [x] move mediawiki stuff -- [x] move boot options -- [] blog post on the perl annihilation -- [] use lib.evalModules over lib.nixosSystem? diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 27e9d447..225eaa74 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -36,6 +36,7 @@ jobs: with: source-url: https://install.lix.systems/lix/lix-installer-x86_64-linux logger: pretty + diagnostic-endpoint: "" - name: Nix Magic Cache uses: DeterminateSystems/magic-nix-cache-action@main diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..f28905d3 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,48 @@ +name: Build and deploy docs + +on: + workflow_dispatch: + push: + paths: + - "docs/**/*" + - ".github/workflows/docs.yml" + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install Lix + uses: DeterminateSystems/nix-installer-action@main + with: + source-url: https://install.lix.systems/lix/lix-installer-x86_64-linux + logger: pretty + diagnostic-endpoint: "" + + - name: Build Linux packages + run: "nix build -L .#docs" + + - name: Upload Pages Artifact + uses: "actions/upload-pages-artifact@v3" + with: + path: "result/" + + deploy: + needs: "build" + runs-on: "ubuntu-latest" + + permissions: + pages: "write" + id-token: "write" + + environment: + name: "github-pages" + url: "${{ steps.deployment.outputs.page_url }}" + + steps: + - name: "Deploy to GitHub Pages" + id: "deployment" + uses: "actions/deploy-pages@v4" diff --git a/.github/workflows/generate-topology.yml b/.github/workflows/generate-topology.yml index dfa6f16a..e695e441 100644 --- a/.github/workflows/generate-topology.yml +++ b/.github/workflows/generate-topology.yml @@ -28,7 +28,7 @@ jobs: - name: Move files run: | nix shell nixpkgs#imagemagick - magick ./result/topology.svg ./.github/images/topology.png + magick ./result/topology.svg ./docs/src/images/topology.png - name: Commit & Push uses: endbug/add-and-commit@v9 diff --git a/README.md b/README.md index d22e1ee3..3a7d0e72 100644 --- a/README.md +++ b/README.md @@ -34,26 +34,6 @@ ![image of my flakes topology](./.github/images/topology.png) - - -- [Foreword](#foreword) -- [What does this repo provided](#what-does-this-repo-provided) -- [Config layout](#config-layout) -- [Usage Notes](#usage-notes) - - [Using the templates](#using-the-templates) - - [Shortcuts](#shortcuts) - - [Installation Notes](#installation-notes) - - [NixOS](#nixos) - - [Dual boot](#dual-boot) - - [macOS](#macos) - - [Small bits](#small-bits) -- [Additional notes](#additional-notes) - - [Resources](#resources) - - [Projects / Configurations](#projects-configurations) - - [People](#people) - - - ### Foreword This repository contains my **personal** configuration for my systems, so its really important that you know it's **personal** and not everything will fit your needs. @@ -62,9 +42,6 @@ Therefore most things will not work out of the box without some changes, so be w > [!WARNING] > Also to note that this configuration will **not** work if you do not change any of the [secrets](./secrets) since they are encrypted. -> [!TIP] -> You can find some cool blogs and people at the bottom of this file, or [click here](#additional-notes) - ### What does this repo provided - Several applications and tools for my needs, but you can choose the one that best suits your needs @@ -77,183 +54,7 @@ Therefore most things will not work out of the box without some changes, so be w - Docs kind of - [Catppuccin](https://github.com/catppuccin/catppuccin) everywhere, with a hint of [evergarden](https://github.com/comfysage/evergarden) -### Config layout - -- ๐Ÿ  [home](./home/) Where all home-manager configurations lie -- ๐Ÿ–ฅ๏ธ [systems](./systems/) - - โ˜€๏ธ [Amaterasu](./systems/amaterasu) My high-end gaming machine - - ๐Ÿ‰ [Hydra](./systems/hydra/) A super mid spec laptop - - โšธ [Lilith](./systems/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh - - โš–๏ธ [minerva](./systems/minerva/) A server configuration for some of my infrastructure - - ๐–ค [Valkyrie](./systems/valkyrie/) A WSL2 host, designed to be a development environment on Windows - - ๐Ÿ’ฎ [Tatsumaki](./systems/tatsumaki/) A MacBook Air, configured to last a whole day of university -- ๐Ÿงฉ [parts](./parts/) NixOS parts breaking down the complex configuration into smaller more manageable chunks - - ๐Ÿ“š [lib](./parts/lib/) Useful repeated functions - - ๐Ÿ› ๏ธ [templates](./parts/templates/) Templates for setting up development environments - - ๐Ÿ‘พ [modules](./parts/modules/) Exported modules for NixOS, home-manager and Nix Darwin -- ๐Ÿ”Œ [modules](./modules/) - - [base](./modules/base/) The base configuration settings, which are common between all systems - - [darwin](./modules/darwin/) Pre-made modules for exclusively darwin systems - - [nixos](./modules/nixos/) Pre cooked modules for exclusively nixos systems - - [iso](./modules/iso/) Pre-configured modules prepared for making NixOS iso images - - [extra](./modules/extra) Extra configuration modules, for home-manager and Nix Darwin and NixOS - - [profiles](./modules/profiles/) Pre-made profiles for different system types - - [hardware](./modules/profiles/hardware) Optimized settings for different devices (e.g., laptop, servers, desktop) - - [meta](./modules/profiles/meta) Optimized configurations for different natures (e.g., headless, graphical) - -> [!TIP] -> When looking for my custom modules or packages you should direct yourself to [isabelroses/beapkgs](https://github.com/isabelroses/beapkgs). If you are specifically looking for remote modules (sometimes not clearly labelled), it is worth looking through the [beapkgs docs](https://isabelroses.github.io/beapkgs/). - -### Usage Notes - -#### Using the templates - -To use the templates there are two commands you can run, they are: - -- `nix flake init -t github:isabelroses/dotfiles#