Renovate the docs

.github/README.md

@@ -0,0 +1,66 @@
+# Hjem Rum
+
+[Hjem]: https://github.com/feel-co/hjem
+[documentation]: rum.snugnug.org
+[our docs]: ./CONTRIBUTING.html
+[@NotAShelf]: https://github.com/NotAShelf
+[@eclairevoyant]: https://github.com/eclairevoyant
+[contributors]: https://github.com/snugnug/hjem-rum/graphs/contributors
+[Home Manager]: https://github.com/nix-community/home-manager
+[license]: https://github.com/snugnug/hjem-rum/blob/main/LICENSE
+
+A module collection for managing your `$HOME` with [Hjem].
+
+## A brief explanation
+
+> [!WARNING]
+> Hjem Rum is currently considered alpha software―here be dragons. While many of
+> us currently use its modules in our NixOS configurations, that does not mean
+> it will necessarily offer a seamless experience yet, nor does it mean there
+> will not be breaking changes (there will). As Hjem Rum continues to grow and
+> evolve, it should become more stable and expansive, but please be patient as
+> it is a hobby project. Furthermore, Hjem, the tooling Hjem Rum is built off
+> of, is still unfinished and missing critical features, such as services. Hjem
+> Rum is still useable, but it is not for the novice user.
+
+Built off the Hjem tooling, Hjem Rum (loosely translated to "rooms of a home")
+is a collection of modules for various applications intended to simplify `$HOME`
+management for usage and configuration of applications.
+
+Hjem was initially created as a streamlined implementation of the `home`
+functionality that Home Manager provides. Hjem Rum, in contrast, is intended to
+provide an expansive module collection as a useful abstraction for users to
+configure their applications with ease, recreating Home Manager's complete
+functionality.
+
+## Usage and Documentation
+
+Hjem Rum includes a full set of documentation, including an options search
+system. Please see our [documentation] for both guides on installing Hjem Rum
+and a full list of options that you can configure programs with.
+
+## Contribution
+
+If you are interested in contributing to Hjem Rum, please check out our
+contributing guidelines on [our docs]. We are always interested in
+contributions, particularly as Hjem Rum is a project with an inherently enormous
+scope. If you are new, unfamiliar, or otherwise scared of trying to contribute,
+please know that any contribution helps, big or small, and that reviewers are
+here to help you contribute and write good code for this project.
+
+## Credits
+
+Credit goes to [@NotAShelf] and [@eclairevoyant] for creating Hjem.
+
+We would also like to give special thanks to all [contributors], past and
+present, for making Hjem Rum what it is today.
+
+Additionally, we would like to thank everyone who has contributed or maintained
+[Home Manager], as without them, this project likely would not be possible, or
+even be conceived.
+
+## License
+
+All the code within this repository is protected under the GPLv3 license unless
+explicitly stated otherwise within a file. Please see [LICENSE] for more
+information.

.github/workflows/docs-check.yml

@@ -0,0 +1,43 @@
+name: "Docs Check"
+permissions: read-all
+
+on:
+  pull_request:
+    branches:
+      - main
+    path:
+      - modules/collection/**
+      - modules/lib/**
+      - docs/**
+      - flake.nix
+      - flake.lock
+      - .github/workflows/docs-check.yml
+
+jobs:
+  docs-check:
+    name: "Test build docs"
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build documentation packages
+        run: nix build .#docs -Lv
+
+  lychee-check:
+    name: "Link checker"
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build documentation packages
+        run: nix build .#docsLinkCheck -Lv

docs/CNAME

@@ -0,0 +1 @@
+rum.snugnug.org