Home

🔍🐟 fzf.fish wiki ✏️📘

Welcome to the Wiki, where you can read the Q&A style help or learn about the vision of this project!

Bear in mind that while I update the Wiki in lockstep with the main branch, I do not keep around documentation pertaining only to previous versions. Therefore, consider updating fzf.fish before reading the Wiki.

Why are new issues, pull requests, and discussions disabled?

First off, fzf.fish is not abandoned. The truth is I'm burnt out with fzf.fish. I love adding new features, but providing support and helping users debug issues that mostly turn out to be user error has been frustrating and time consuming. I invested significantly in the Troubleshooting guide and directing users opening new issues toward reading it and searching previous issues but I still felt I was bombarded with duplicate requests. I know I can just disable notifications and not check fzf.fish but it's hard not to, and I think it would be rude for people to ask questions and not get a reply for months. So instead, my new plan is to by default disable interactions with the repository, but when I add new features re-enable it for a time to gather feedback and bug reports until I think it's safe to close it again. I believe that in the long run, this is better for everyone because I will have more energy to working on fzf.fish.

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 can 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. It requires a lot of effort to balance that.
• No matter how succinct I tried to be, the readme was becoming very long, such that it was intimidating for prospective users and hard to navigate for existing users.
• People reading the git log for the latest changes likely find non-feature-related diffs and commits changes distracting.
• Making updates to the front page of the repo is anxiety-ridden for me, but updating Wiki much less so.
• Having multiple pages and a sidebar at my disposal makes organizing the content easier.
• Much 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.