docs: add help indexes (#2684)

* docs: add nvim-tree-index-api

* docs: add nvim-tree-index-opts

* docs: add nvim-tree-index-api

* docs: sort indices

* docs: less verbose

* docs: use dictionary sort for indices
This commit is contained in:
Alexander Courtis
2024-02-24 17:53:25 +11:00
committed by GitHub
parent 7efaa339d3
commit d52fdeb0a3
3 changed files with 303 additions and 0 deletions

View File

@@ -69,10 +69,16 @@ Once you did, you should run `make help-update`
# Documentation
## Opts
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
Documentation for options should also be added to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
## API
When adding or changing API please update :help nvim-tree-api
# Pull Request
Please reference any issues in the description e.g. "resolves #1234".