maintaining: init

Add a MAINTAINING.md file where we can document internal maintenance
procedures.
This commit is contained in:
Matt Sturgeon 2025-05-23 21:22:05 +01:00
parent e3f4a57fb8
commit f39dd42824
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 9 additions and 1 deletions

4
MAINTAINING.md Normal file
View file

@ -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.

View file

@ -28,4 +28,5 @@
---
[Contributing](./CONTRIBUTING.md)
[Maintaining](./MAINTAINING.md)
[NixVim Options Search](./search/index.html)

View file

@ -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}/*