Add the name of the command in the documentation.
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 27k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
For a better readability of the Vimium documentation, please add the name of the command, when referencing a command, rather than just naming the keyboard shortcut of the command.
For example : "(type "o" (Vomnibar.activate) to open the Vomnibar)" instead of just "(type "o" to open the Vomnibar)".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the Vimium documentation for references that identify commands only by their keyboard shortcuts, using the Vomnibar example and Vomnibar.activate as a starting point. Update those references to include the command name alongside the shortcut, and confirm that command references consistently provide both pieces of information.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100