epwalsh / epwalsh/obsidian.nvim

Readme is vague about what the difference between ObsidianSearch and ObsidianQuickSwitch is

Open Beginner friendly
#760 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Lua
Stars
6.2k
Forks
250
PR merge metrics
No merged PRs in 30d

Description

### 📚 The doc issue

In the readme under the commands heading, it says two commands, ObsidianSearch and ObsidianQuickSwitch, but the documentation does not say anything in more detail about them. Their descriptions are very similar, so it's unclear to the user what the difference is or why to use one over the other.

### Suggest a potential alternative/fix

A more detailed description of both commands and their functionality.

Contributor guide

Open the contributing guide

Research direction

Open the README and find the commands heading containing ObsidianSearch and ObsidianQuickSwitch. Compare their documented functionality and add distinct descriptions explaining the difference and when to use each. Done means users can understand both commands without consulting other sources.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.