-
Notifications
You must be signed in to change notification settings - Fork 105
Home
Patrick edited this page Feb 2, 2021
·
25 revisions
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.
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. 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.
- Most 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 makes is more anxiety-ridden for me than releasing new features.
- Having multiple pages and a sidebar at my disposal makes organizing my thoughts a lot easier.
- 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.