docs: Documentation refactor (#248)

* docs: Restructure documentation and update references

* Auto generate docs

* docs: Restructure documentation and update references

* docs(nvim): Update CLI documentation reference path

* Auto generate docs

* skip api references for CLI for now.

* docs(nvim): Document job runner API

* docs: Clarify API documentation for synchronous vs. async retrieval

* Auto generate docs

* fix links

* build nvim api references

* Auto generate docs

---------

Co-authored-by: Davidyz <Davidyz@users.noreply.github.com>

Author: Davidyz

.github/workflows/panvimdoc.yml

@@ -11,11 +11,29 @@ jobs:
     name: pandoc to vimdoc
     steps:
       - uses: actions/checkout@v4
+
       - name: panvimdoc
         uses: kdheepak/panvimdoc@main
         with:
           vimdoc: "VectorCode" # Output vimdoc project name (required)
-          pandoc: "./docs/neovim.md" # Input pandoc file
+          pandoc: "./docs/neovim/README.md" # Input pandoc file
+          toc: true # Table of contents
+          description: "A code repository indexing tool to supercharge your LLM experience." # Project description used in title (if empty, uses neovim version and current date)
+          titledatepattern: "%Y %B %d" # Pattern for the date that used in the title
+          demojify: true # Strip emojis from the vimdoc
+          dedupsubheadings: true # Add heading to subheading anchor links to ensure that subheadings are unique
+          treesitter: true # Use treesitter for highlighting codeblocks
+          ignorerawblocks: true # Ignore raw html blocks in markdown when converting to vimdoc
+          docmapping: false # Use h4 headers as mapping docs
+          docmappingprojectname: true # Use project name in tag when writing mapping docs
+          shiftheadinglevelby: 0 # Shift heading levels by specified number
+          incrementheadinglevelby: 0 # Increment heading levels by specified number
+
+      - name: panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: "VectorCode-API" # Output vimdoc project name (required)
+          pandoc: "./docs/neovim/api_references.md" # Input pandoc file
           toc: true # Table of contents
           description: "A code repository indexing tool to supercharge your LLM experience." # Project description used in title (if empty, uses neovim version and current date)
           titledatepattern: "%Y %B %d" # Pattern for the date that used in the title

README.md

@@ -44,11 +44,11 @@ model output and reduce hallucination.
 
 - For the setup and usage of the command-line tool, see [the CLI documentation](./docs/cli.md);
 - For neovim users, after you've gone through the CLI documentation, please refer to 
-  [the neovim plugin documentation](./docs/neovim.md) for further instructions.
+  [the neovim plugin documentation](./docs/neovim/README.md) (and optionally the [lua API reference](./docs/neovim/api_references.md)) 
+  for further instructions.
 - Additional resources:
   - the [wiki](https://github.com/Davidyz/VectorCode/wiki) for extra tricks and
-    tips that will help you get the most out of VectorCode, as well as
-    instructions to setup VectorCode to work with some other neovim plugins;
+    tips that will help you get the most out of VectorCode;
   - the [discussions](https://github.com/Davidyz/VectorCode/discussions) where
     you can ask general questions and share your cool usages about VectorCode.
   - If you're feeling adanvturous, feel free to check out