refactor(docs): part 12 - update API references docs

[linrongbin16]

Regresion test

Platforms

• [ ] windows
• [x] macOS
• [ ] linux

Tasks

• [x] FzfxFiles
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between restricted/unrestricted mode, and the lines count is consistent when press multiple times.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • Both fd and find works.
• [x] FzfxLiveGrep
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between restricted/unrestricted mode, and the lines count is consistent when press multiple times.
  • Use -w to match word only, use -g *.lua to search only lua files.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • Both rg and grep works.
• [x] FzfxBufLiveGrep
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use -w to match word only, use -g *.lua to search only lua files.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
  • Both rg and grep works.
• [x] FzfxBuffers
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-D to delete buffers, and delete the test/hello world.txt, test/goodbye world/goodbye.lua buffers.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxGFiles
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current folder mode.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxGLiveGrep
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxGStatus
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current folder mode.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
  • Both with/without delta works.
• [x] FzfxGBranches
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-R/CTRL-O to switch between local/remote branches.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to checkout branch.
• [x] FzfxGCommits
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-A to switch between git repo commits/current buffer commits.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to copy commit hash.
  • Both with/without delta works.
• [x] FzfxGBlame
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to copy commit hash.
  • Both with/without delta works.
• [x] FzfxLspDiagnostics
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current buffer diagnostics.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxLspDefinitions, FzfxLspTypeDefinitions, FzfxLspReferences, FzfxLspImplementations
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Go to definitions/references (this is the most 2 easiest use case when developing this lua plugin with lua_ls).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxLspIncomingCalls, FzfxLspOutgoingCalls
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Go to incoming/outgoing calls.
  • Press ESC to quit, ENTER to open file.
• [x] FzfxCommands
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-E/CTRL-A to switch between user/ex/all vim commands.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to feed vim command.
• [x] FzfxKeyMaps
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-O/CTRL-I/CTRL-A/CTRL-V to switch between normal/insert/visual/all vim key mappings.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to feed vim keys.
• [x] FzfxMarks
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [x] FzfxFileExplorer
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between filter/include hidden files mode.
  • Press ALT-L/ALT-H to cd into folder and cd upper folder.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • All eza/lsd/ls works.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 94.69697% with 7 lines in your changes missing coverage. Please review.

Project coverage is 81.56%. Comparing base (dea313c) to head (f438332).

Files	Patch %	Lines
lua/fzfx/helper/parsers.lua	96.15%	4 Missing :warning:
lua/fzfx/detail/general.lua	0.00%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #725 +/- ## ========================================== + Coverage 81.51% 81.56% +0.05% ========================================== Files 60 60 Lines 6507 6516 +9 ========================================== + Hits 5304 5315 +11 + Misses 1203 1201 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.