From f39dd428240174bc1d2cbdd07eceebff7c652c03 Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Fri, 23 May 2025 21:22:05 +0100
Subject: [PATCH] maintaining: init

Add a MAINTAINING.md file where we can document internal maintenance
procedures.
---
 MAINTAINING.md          | 4 ++++
 docs/mdbook/SUMMARY.md  | 1 +
 docs/mdbook/default.nix | 5 ++++-
 3 files changed, 9 insertions(+), 1 deletion(-)
 create mode 100644 MAINTAINING.md

diff --git a/MAINTAINING.md b/MAINTAINING.md
new file mode 100644
index 00000000..23a41cad
--- /dev/null
+++ b/MAINTAINING.md
@@ -0,0 +1,4 @@
+# Maintaining Nixvim
+
+This file is intended as a reference for Nixvim's core maintainers, although it may be interesting for anyone curious how we do certain things.
+
diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md
index 88d01d8d..77ecb37b 100644
--- a/docs/mdbook/SUMMARY.md
+++ b/docs/mdbook/SUMMARY.md
@@ -28,4 +28,5 @@
 ---
 
 [Contributing](./CONTRIBUTING.md)
+[Maintaining](./MAINTAINING.md)
 [NixVim Options Search](./search/index.html)
diff --git a/docs/mdbook/default.nix b/docs/mdbook/default.nix
index b7f65563..b1a3b278 100644
--- a/docs/mdbook/default.nix
+++ b/docs/mdbook/default.nix
@@ -347,6 +347,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
   };
 
   contributing = finalAttrs.passthru.fix-links ../../CONTRIBUTING.md;
+  maintaining = finalAttrs.passthru.fix-links ../../MAINTAINING.md;
 
   buildPhase = ''
     mkdir -p $out
@@ -356,8 +357,10 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
     mv ./docs/* ./ && rmdir ./docs
     mv ./mdbook/* ./ && rmdir ./mdbook
 
-    # Copy the contributing file
+    # Copy the contributing and maintaining files
     cp $contributing ./CONTRIBUTING.md
+    substitute $maintaining ./MAINTAINING.md \
+      --replace-fail 'This file' 'This page'
 
     # Symlink the function docs
     for path in ${lib-docs}/*