Merge pull request #74 from jkoelker/include

feat(chat): add `include` role to include files

1 files changed, 19 insertions, 0 deletions

diff --git a/doc/vim-ai.txt b/doc/vim-ai.txt
index f5f2cde..34765d7 100644
--- a/doc/vim-ai.txt
+++ b/doc/vim-ai.txt
@@ -104,6 +104,25 @@ Options: >
 Check OpenAI docs for more information:
 https://platform.openai.com/docs/api-reference/chat
 
+INCLUDE FILES                                  *vim-ai-include*
+
+To include files in the chat a special `include` role is used: >
+
+  >>> user
+
+  Generate documentation for the following files
+
+  >>> include
+
+  /home/user/myproject/requirements.txt
+  /home/user/myproject/**/*.py
+
+Each file's contents will be added to an additional `user` role message with
+the files separated by `==> {path} <==`, where path is the path to the file.
+Globbing is expanded out via `glob.gob` and relative paths to the current
+working directory (as determined by `getcwd()`) will be resolved to absolute
+paths.
+
                                                 *:AINewChat*
 
 :AINewChat {preset shortname}?      spawn a new conversation with a given open