Skip to content

Commit f39dd42

Browse files
committed
maintaining: init
Add a MAINTAINING.md file where we can document internal maintenance procedures.
1 parent e3f4a57 commit f39dd42

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

MAINTAINING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Maintaining Nixvim
2+
3+
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.
4+

docs/mdbook/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@
2828
---
2929

3030
[Contributing](./CONTRIBUTING.md)
31+
[Maintaining](./MAINTAINING.md)
3132
[NixVim Options Search](./search/index.html)

docs/mdbook/default.nix

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
347347
};
348348

349349
contributing = finalAttrs.passthru.fix-links ../../CONTRIBUTING.md;
350+
maintaining = finalAttrs.passthru.fix-links ../../MAINTAINING.md;
350351

351352
buildPhase = ''
352353
mkdir -p $out
@@ -356,8 +357,10 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
356357
mv ./docs/* ./ && rmdir ./docs
357358
mv ./mdbook/* ./ && rmdir ./mdbook
358359
359-
# Copy the contributing file
360+
# Copy the contributing and maintaining files
360361
cp $contributing ./CONTRIBUTING.md
362+
substitute $maintaining ./MAINTAINING.md \
363+
--replace-fail 'This file' 'This page'
361364
362365
# Symlink the function docs
363366
for path in ${lib-docs}/*

0 commit comments

Comments
 (0)