From d2b8e27b1681b2fa5d3722f7fe3b75e432b4bb6b Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Sun, 21 Apr 2024 00:29:17 +0300
Subject: [PATCH] docs: include header and footer in manpages; move man to its
 own dir

---
 docs/default.nix              |  4 +++-
 docs/{ => man}/footer.5       |  0
 docs/{ => man}/header.5       |  3 +--
 docs/{ => man}/neovim-flake.1 | 10 +++++++---
 4 files changed, 11 insertions(+), 6 deletions(-)
 rename docs/{ => man}/footer.5 (100%)
 rename docs/{ => man}/header.5 (80%)
 rename docs/{ => man}/neovim-flake.1 (61%)

diff --git a/docs/default.nix b/docs/default.nix
index 7c2f3fe..60148d7 100644
--- a/docs/default.nix
+++ b/docs/default.nix
@@ -127,10 +127,12 @@
 
       nixos-render-docs -j $NIX_BUILD_CORES options manpage \
         --revision ${revision} \
+        --header ${./man/header.5} \
+        --footer ${./man/footer.5} \
         ${nvimModuleDocs.optionsJSON}/share/doc/nixos/options.json \
         $out/share/man/man5/neovim-flake.5
 
-      cp ${./neovim-flake.1} $out/share/man/man1/neovim-flake.1
+      cp ${./man/neovim-flake.1} $out/share/man/man1/neovim-flake.1
     '';
 
   # Generate the HTML manual pages
diff --git a/docs/footer.5 b/docs/man/footer.5
similarity index 100%
rename from docs/footer.5
rename to docs/man/footer.5
diff --git a/docs/header.5 b/docs/man/header.5
similarity index 80%
rename from docs/header.5
rename to docs/man/header.5
index e3307ed..e512eb0 100644
--- a/docs/header.5
+++ b/docs/man/header.5
@@ -9,6 +9,5 @@
 neovim-flake configuration specification
 .SH "OPTIONS"
 .PP
-You can use the following options in
-home\-configuration\&.nix:
+You can use the following options to configure neovim-flake:
 .PP
diff --git a/docs/neovim-flake.1 b/docs/man/neovim-flake.1
similarity index 61%
rename from docs/neovim-flake.1
rename to docs/man/neovim-flake.1
index 54aab90..7efc6cc 100644
--- a/docs/neovim-flake.1
+++ b/docs/man/neovim-flake.1
@@ -9,13 +9,17 @@
 .cflags 4 /
 .Sh NAME
 .Nm neovim-flake
-.Nd a extensible and distro-agonistic Neovim configuration wrapper in Nix
+.Nd A highly modular, extensible and distro-agnostic Neovim distribution for Nix/NixOS.
 .
 .Sh BUGS
 .Pp
-Please report any bugs on the
+Please report any bugs that you might encounter on the
 \m[blue]\fBproject issue tracker\fR\m[]\&.
 
+.Sh SEE ALSO
+.Pp
+\fBneovim-flake\fR(5)
+
 .Sh AUTHOR
 .Pp
 \fBneovim-flake contributors\fR
@@ -25,5 +29,5 @@ Author.
 
 .Sh COPYRIGHT
 .br
-Copyright \(co 2017\(en2022 neovim-flake contributors
+Copyright \(co 2023\(en2024 neovim-flake contributors
 .br