NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-23 05:40:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update release notes & contributing guidelines

Browse source
This commit is contained in:
raf 2023-11-06 11:24:33 +03:00
parent 385d91f7e4
commit f27ab70202
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/manual/hacking.adoc
View file

@ -144,6 +144,7 @@ For example:
[source,nix] [source,nix]
---- ----
# parent modules should always be unfolded # parent modules should always be unfolded
# which means module = { value = ... } instead of module.value = { ... }
module = { module = {
value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible 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. 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 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. adding a new module will apply here.
[[sec-keybinds]] [[sec-keybinds]]

5
docs/release-notes/rl-0.5.adoc
View file

@ -74,6 +74,11 @@ https://github.com/notashelf[notashelf]:
* Added `nvim-docs-view`, a plugin to display lsp hover documentation in a side panel * 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]: https://github.com/jacekpoz[jacekpoz]:
* Fixed scrollOffset not being used * Fixed scrollOffset not being used