Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
Patrick edited this page Feb 2, 2021 · 25 revisions

πŸ”πŸŸ fzf.fish wiki βœοΈπŸ“˜

Welcome to the Wiki, where you can read the Q&A style help or learn about the vision of this project! Readers take note: since the Wiki exists outside of the fzf.fish git repo, the documentation can only be assumed to be accurate for the latest commit on the main branch. Therefore, if you are not running the latest release of fzf.fish, the Wiki may not be accurate for you.

Why did I move documentation from the readme to the Wiki?

Much of the content of the Wiki originally lived in the readme. Initially, it made sense to consolidate all the documentation on the readme as the readme is easily accessible and could be updated alongside the code. However, this became burdensome and counterproductive as the plugin grew:

  • There is a tension between providing comprehensive documentation and keeping the readme easy to scroll through.
  • No matter how succinct I tried to keep each section--even at the cost of important details--it was becoming difficult to quickly find what one is looking for.
  • A long readme that can't be finished in one sitting is intimidating for prospective users.
  • Most people reading the git log for the latest changes likely find non-feature-related diffs and commits changes distracting.
  • Having to commit and push adds friction to the process.
  • Making updates to the front page of the repo makes writing English more anxiety-ridden for me than releasing new features.
  • A Wiki naturally lends itself to organizing all the thoughts I want to write down.
  • A lot of what I wanted to explain to users is not documentation per se (e.g. FAQ and design philosophy).
  • Finally, I obsess over my words and find myself writing and rewriting every sentence again and again.

Clone this wiki locally

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /