From 344348512ecded6cbd29249816584594f8a90a52 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Thu, 7 Nov 2024 15:07:22 +0300 Subject: [PATCH] docs/preface: include project description in the preface --- docs/manual/preface.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/manual/preface.md b/docs/manual/preface.md index 26e3070..ce3e42e 100644 --- a/docs/manual/preface.md +++ b/docs/manual/preface.md @@ -1,7 +1,20 @@ # Preface {#ch-preface} -If you noticed a bug caused by **nvf** then please consider reporting it over -[the issue tracker](https://github.com/notashelf/nvf/issues). +## What is nvf {#sec-what-is-it} -Bugfixes, feature additions and upstreamed changes from your local configurations -are always welcome in the [the pull requests tab](https://github.com/notashelf/nvf/pulls). +nvf is a highly modular, configurable, extensible and easy to use Neovim +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].