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

docs/preface: include project description in the preface

Browse source
This commit is contained in:
raf 2024-11-07 15:07:22 +03:00
parent ce6799c9d8
commit 344348512e
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/manual/preface.md
View file

@ -1,7 +1,20 @@
# Preface {#ch-preface} # Preface {#ch-preface}
If you noticed a bug caused by **nvf** then please consider reporting it over ## What is nvf {#sec-what-is-it}
[the issue tracker](https://github.com/notashelf/nvf/issues).
Bugfixes, feature additions and upstreamed changes from your local configurations nvf is a highly modular, configurable, extensible and easy to use Neovim
are always welcome in the [the pull requests tab](https://github.com/notashelf/nvf/pulls). configuration in Nix. Designed for flexibility and ease of use, nvf allows you
to easily configure your fully featured Neovim instance with a few lines of Nix.
## Bugs & Suggestions {#sec-bugs-suggestions}
[issue tracker]: https://github.com/notashelf/nvf/issues
[discussions tab]: https://github.com/notashelf/nvf/discussions
[pull requests tab]: https://github.com/notashelf/nvf/pulls
If you notice any issues with nvf, or this documentation, then please consider
reporting them over at the [issue tracker]. Issues tab, in addition to the
[discussions tab] is a good place as any to request new features.
You may also consider submitting bugfixes, feature additions and upstreamed
changes that you think are critical over at the [pull requests tab].