From f27ab702021c331c421416f71472d9485d442ba2 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 6 Nov 2023 11:24:33 +0300 Subject: [PATCH] docs: update release notes & contributing guidelines --- docs/manual/hacking.adoc | 3 ++- docs/release-notes/rl-0.5.adoc | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/manual/hacking.adoc b/docs/manual/hacking.adoc index 33ed8e0..51995b8 100644 --- a/docs/manual/hacking.adoc +++ b/docs/manual/hacking.adoc @@ -144,6 +144,7 @@ For example: [source,nix] ---- # parent modules should always be unfolded +# which means module = { value = ... } instead of module.value = { ... } module = { value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible @@ -202,7 +203,7 @@ without any error messages (you can check the output of `:messages` inside neovi your changes are good to go. Open your pull request, and it will be reviewed as soon as posssible. If it is not a new module, but a change to an existing one, then make sure the module you have changed is enabled in the -maximal configuration by editing configuration.nix, and then run it with `nix run .#maximal -Lv`. Same procedure as +maximal configuration by editing `configuration.nix`, and then run it with `nix run .#maximal -Lv`. Same procedure as adding a new module will apply here. [[sec-keybinds]] diff --git a/docs/release-notes/rl-0.5.adoc b/docs/release-notes/rl-0.5.adoc index f0c72b8..bc0dde9 100644 --- a/docs/release-notes/rl-0.5.adoc +++ b/docs/release-notes/rl-0.5.adoc @@ -74,6 +74,11 @@ https://github.com/notashelf[notashelf]: * Added `nvim-docs-view`, a plugin to display lsp hover documentation in a side panel +* Switched to `nixosOptionsDoc` in option documentation. +To quote home-manager commit: "Output is mostly unchanged aside from some minor typographical and +formatting changes, along with better source links." + + https://github.com/jacekpoz[jacekpoz]: * Fixed scrollOffset not being used