From 81ea7547e5b429b97524dff872e1e7b1486cefe6 Mon Sep 17 00:00:00 2001 From: Oleksandr Smirnov Date: Sat, 30 Aug 2025 16:09:17 +0300 Subject: [PATCH] chore: update CONTRIBUTING --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 257d94a..554e358 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,11 +25,15 @@ task lint ### Documentation Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md) -for generating help files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments. +for generating vimhelp files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments. + +For demo gifs in [readme](./README.md) we're using [vhs](https://github.com/charmbracelet/vhs). +All files related to demos live in [/vhs](./vhs) dir. You can generate docs with: ```bash -task docgen +task docgen # generates vimhelp +task vhs:generate # generates demo gifs ``` ### Commit messages