chore: Auto generate docs

Author: towry

doc/commit-msg-sg.txt

@@ -7,14 +7,31 @@ Your plugin configuration with its default values.
 Default values:
 >
   CommitMsgSg.options = {
-    ---@type string|function
+    -- Can be string or function that returns cwd.
+    --@type string|function
     cwd = nil,
+    -- auto attach on gitcommit filetype.
     auto_setup_gitcommit = true,
+    -- auto create user command `WriteGitCommitMessage`.
     auto_setup_command = true,
+    -- callback when AI is started and attached to current buffer. (client, bufnr)
+    -- You can create your own buffer local commands or keymaps in this callback.
     on_attach = nil,
     ghost_text = "Thinking...",
-    -- customized function to generate prompt string.
+    -- function to generate prompt string.
+    -- accept a callback that takes input as prompt string.
+    -- ```lua
+    -- prompt_gen = function(callback)
+    --   -- some async operation to generate prompt.
+    --   local generated_prompt_string = 'The prompt string ...'
+    --   callback(error_or_nil, generated_prompt_string)
+    -- end
+    -- ```
     prompt_gen = nil,
+    -- default prompt string if you do not want to use prompt_gen.
+    -- default_prompt = [[Some prompt string ... The diff content is: %s]]
+    -- Note: the staged diff content is generated so you can use it in your prompt to
+    -- add more context.
     default_prompt = nil,
     -- @private
     executor = "sg",