skywind3000 / skywind3000/vim-quickui

Add documents for `:QuickUI` `g:quickui` `g:quickui_context` `g:quickui_context_foot`

Open
#83 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vim Script
Stars
1.2k
Forks
41
PR merge metrics
No merged PRs in 30d

Description

I found some global options (g:quickui g:quickui_context g:quickui_context_foot) in autoload/quickui/command.vim file, which may be related to :QuickUI command. But they don't appear in MANUAL.md, wiki pages, or other help files.

Could we add some documents about them?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the global options in autoload/quickui/command.vim, then review MANUAL.md, the wiki pages, and other help files for the existing :QuickUI documentation. Document g:quickui, g:quickui_context, and g:quickui_context_foot, including how they relate to :QuickUI; done means the options are covered in the project documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.