Improve Documentation

[jackMort]

Document all the flows and config options, add some actions examples

[Nokodoko]

Hey Jack I'd love to help here. To make sure that I'm working on the right thing: You are referring to the actions.json file, and making documentation and example usage for each of those?

[wtanksleyjr]

I'd love to see this - I decided to switch to nvim because of this, but then I found that none of the installation instructions bears any resemblance to anything I know about. Packer I guess is a module manager, but installing Packer itself is apparently beyond me (the terse instructions on its own site just produce pages of errors for me). I thought vim itself was supposed to be hard to use, nvim seems to have it beat.

[Nokodoko]

Understanding the lua runtime path (rtp) and calling lua modules it will help. That said, the setup configuration is mentioned in the Readme.md If you use:

      require("chatgpt").setup({
        -- optional configuration
      })

in your init.lua you should be good. There are a lot of great videos on how to configure neovim, but if you are just starting I would suggest using a pre-made, or out the box variant: https://github.com/AstroNvim/AstroNvim (there are several, this is the first one that came to mind).

[wtanksleyjr]

Fantastic tip, that got me moving in the right direction. Thank you! I just ran my first ChatGPTEditWithInstructions, great results.

[rounakcodes]

I'd love to see this - I decided to switch to nvim because of this, but then I found that none of the installation instructions bears any resemblance to anything I know about. Packer I guess is a module manager, but installing Packer itself is apparently beyond me (the terse instructions on its own site just produce pages of errors for me). I thought vim itself was supposed to be hard to use, nvim seems to have it beat.

True.

https://www.youtube.com/playlist?list=PLhoH5vyxr6Qq41NFL4GvhFp-WLd5xzIzZ

This made my life simpler. I don't write lua but I have a fairly good idea what is going on when I am adding a new plugin. Instead of spending hours trying to make something work everytime, better to understand the basics once!

[bruteforks]

the same guy chris@machine also has this really good starting point config

[CulleyHarrelson]

I think the installation instructions could use another review. "Make sure you have curl installed" is pretty weak installation instructions compared to all the talk about password managers. I think having a basic installation instruction with the environment variable would be a good starting point for launching into more secure password management.

[jackMort]

Feel free to add PR with better instructions