Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #72

Merged
merged 1 commit into from
Dec 9, 2023
Merged

Add documentation #72

merged 1 commit into from
Dec 9, 2023

Conversation

tarruda
Copy link
Contributor

@tarruda tarruda commented Dec 2, 2023

Hi

This is a very nice plugin, probably the best LLM integration I've seen so far.

One thing that it is currently missing is documentation, so I asked GPT-4 Turbo to generate it. The promt was:

This is the code for a Neovim Lua plugin. Please generate a Vim documentation for the plugin (should be a text file in the format expected by vim):

(then pasted the code for init.lua)

This is what it generated. Not sure if it is very accurate, but maybe we can use as a starting point (feel free to push changes to this PR).

I pasted `init.lua` and asked "gpt-4-1106-previe" to generate
documentation for the plugin.

Signed-off-by: Thiago Padilha <[email protected]>
@Robitx Robitx merged commit 3232db6 into Robitx:main Dec 9, 2023
@tarruda tarruda deleted the add-help branch December 11, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants