Skip to content

Overhaul documentation #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 27 commits into from
Oct 20, 2022
Merged

Overhaul documentation #270

merged 27 commits into from
Oct 20, 2022

Conversation

PatrickF1
Copy link
Owner

@PatrickF1 PatrickF1 commented Oct 20, 2022 •
edited
Loading

  • Refer to "search features" as "search commands", which is clearer.
  • Clearly give each search command a capitalized, canonical name so it can be clearly referred to in the rest of the docs.
  • Explicitly call out the "type" of the output of each command to be unambiguous.
  • Add emojis in search command docs so they are more distinguishable when quickly scrolling.
  • Make configuration docs more concise and clearer.
  • Point out fd and bat only need to be installed if using Search Directory.

@PatrickF1 PatrickF1 closed this Oct 20, 2022
@PatrickF1 PatrickF1 deleted the readme-overhail branch October 20, 2022 01:27
@PatrickF1 PatrickF1 restored the readme-overhail branch October 20, 2022 01:27
@PatrickF1 PatrickF1 reopened this Oct 20, 2022
@PatrickF1 PatrickF1 changed the title Readme overhaul Overhaul documentation Oct 20, 2022
PatrickF1
PatrickF1 commented Oct 20, 2022
View reviewed changes
README.md

- add [key bindings](https://www.mankier.com/1/fzf#Key/Event_Bindings) within fzf to operate on the selected line:
- [open file in Vim](https://github.com/junegunn/fzf/issues/1360)
- [preview image files](https://gitter.im/junegunn/fzf?at=5947962ef6a78eab48620792)
- [copy to clipboard](https://betterprogramming.pub/boost-your-command-line-productivity-with-fuzzy-finder-985aa162ba5d)
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deleted this because it is now paywalled

PatrickF1
PatrickF1 commented Oct 20, 2022
View reviewed changes
README.md

### File paths
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding emojis to distinguish each section: currently, if you scroll quickly through the features, they all look about the same.

@PatrickF1 PatrickF1 merged commit aefa57a into main Oct 20, 2022
@PatrickF1 PatrickF1 deleted the readme-overhail branch October 20, 2022 18:56
PatrickF1 added a commit that referenced this pull request Oct 20, 2022
@PatrickF1
refer to Search History and Search Variables using the same name
a8ef424 
The docs sometimes inconsistently referred to Search History as Search Command History, and Search Variables as Search Shell Variables.
Use a consistent, canonical name so there is no ambiguity or confusion at all. That was one of the goals of #270.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@PatrickF1