From cd68b680cdc35a48d7972721eba7eda370b9912f Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Wed, 23 Oct 2024 14:10:31 +0100
Subject: [PATCH] docs: rename `modules` -> `platforms`

---
 README.md                                      | 2 +-
 docs/mdbook/SUMMARY.md                         | 4 ++--
 docs/mdbook/default.nix                        | 6 +++---
 docs/{modules => platforms}/standalone.md      | 0
 docs/{modules => platforms}/wrapper-options.md | 0
 docs/user-guide/config-examples.md             | 2 +-
 docs/user-guide/faq.md                         | 2 +-
 docs/user-guide/install.md                     | 4 ++--
 8 files changed, 10 insertions(+), 10 deletions(-)
 rename docs/{modules => platforms}/standalone.md (100%)
 rename docs/{modules => platforms}/wrapper-options.md (100%)

diff --git a/README.md b/README.md
index efbb13e1..1c586ca7 100644
--- a/README.md
+++ b/README.md
@@ -256,7 +256,7 @@ It takes a set with the following keys:
 - `extraSpecialArgs`: Extra arguments to pass to the modules when using functions.
   Can be `self` in a flake, for example.
 
-For more detail, see the [Standalone Usage](https://nix-community.github.io/nixvim/modules/standalone.html) section of our documentation.
+For more detail, see the [Standalone Usage](https://nix-community.github.io/nixvim/platforms/standalone.html) section of our documentation.
 
 ### With a `devShell`
 
diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md
index 75fdcb09..c9f1c0dd 100644
--- a/docs/mdbook/SUMMARY.md
+++ b/docs/mdbook/SUMMARY.md
@@ -11,8 +11,8 @@
 
 # Platforms
 
-- [Platform-specific options](./modules/wrapper-options.md)
-- [Standalone Usage](./modules/standalone.md)
+- [Platform-specific options](./platforms/wrapper-options.md)
+- [Standalone Usage](./platforms/standalone.md)
 
 # Options
 
diff --git a/docs/mdbook/default.nix b/docs/mdbook/default.nix
index dc52da5c..6fb20fb4 100644
--- a/docs/mdbook/default.nix
+++ b/docs/mdbook/default.nix
@@ -228,7 +228,7 @@ let
     wrapperOptionFiles = lib.mapAttrs' (name: options: {
       name = options.meta.wrapper.name.value;
       # TODO:
-      # value.path = "./modules/${name}.md";
+      # value.path = "./platforms/${name}.md";
       value.file = mkMDDoc options;
     }) wrapperOptions;
 
@@ -298,7 +298,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
     root = ../../.;
     fileset = lib.fileset.unions [
       ../user-guide
-      ../modules
+      ../platforms
       ../../CONTRIBUTING.md
       (lib.fileset.fileFilter (
         { type, hasExt, ... }:
@@ -328,7 +328,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
     substituteInPlace ./SUMMARY.md \
       --replace-fail "@NIXVIM_OPTIONS@" "$nixvimOptionsSummary"
 
-    substituteInPlace ./modules/wrapper-options.md \
+    substituteInPlace ./platforms/wrapper-options.md \
       --replace-fail "@WRAPPER_OPTIONS@" "$(cat ${finalAttrs.passthru.wrapperOptionDocs})"
 
     mdbook build
diff --git a/docs/modules/standalone.md b/docs/platforms/standalone.md
similarity index 100%
rename from docs/modules/standalone.md
rename to docs/platforms/standalone.md
diff --git a/docs/modules/wrapper-options.md b/docs/platforms/wrapper-options.md
similarity index 100%
rename from docs/modules/wrapper-options.md
rename to docs/platforms/wrapper-options.md
diff --git a/docs/user-guide/config-examples.md b/docs/user-guide/config-examples.md
index 7c80afde..73bf0f94 100644
--- a/docs/user-guide/config-examples.md
+++ b/docs/user-guide/config-examples.md
@@ -7,7 +7,7 @@ Take a look at these configuration examples below.
 <!-- TODO: add info about `kickstart.nixvim` -->
 
 **Note:**\
-Most of those configurations are using a [standalone build](../modules/standalone.html), however,
+Most of those configurations are using a [standalone build](../platforms/standalone.html), however,
 all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
 
 | Config | Comment |
diff --git a/docs/user-guide/faq.md b/docs/user-guide/faq.md
index 2d471858..d2fc15fe 100644
--- a/docs/user-guide/faq.md
+++ b/docs/user-guide/faq.md
@@ -65,7 +65,7 @@ If you are building nixvim using the NixOS, home-manager, or nix-darwin modules
 > [!TIP]
 > Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system.
 
-[standalone]: ./modules/standalone.md
+[standalone]: ../platforms/standalone.md
 
 ## How do I create multiple aliases for a single keymap
 
diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md
index e2afdcd7..2c8b416b 100644
--- a/docs/user-guide/install.md
+++ b/docs/user-guide/install.md
@@ -70,7 +70,7 @@ options as `programs.nixvim.<path>.<to>.<option> = <value>`.
 When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively.
 This is useful is you use nixvim both as part of an environment and as standalone.
 
-For more information on module-specific options, see [Platform-specific options](../modules/wrapper-options.md).
+For more information on module-specific options, see [Platform-specific options](../platforms/wrapper-options.md).
 
 ### Standalone usage
 
@@ -88,4 +88,4 @@ The nixvim derivation can then be used like any other package!
 
 For an example, see the [nixvim standalone flake template](https://github.com/nix-community/nixvim/blob/main/templates/simple/flake.nix).
 
-For more information see [Standalone Usage](../modules/standalone.md).
+For more information see [Standalone Usage](../platforms/standalone.md).