Overhaul documentation #270
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
PatrickF1
commented
Oct 20, 2022
•
PatrickF1
commented
- 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
force-pushed
the
readme-overhail
branch
from
c027860 to
8fc977c
Compare
PatrickF1
commented
Oct 20, 2022
|
|
||
| - 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) |
There was a problem hiding this comment.
deleted this because it is now paywalled
PatrickF1
commented
Oct 20, 2022
|
|
||
| ### File paths |
There was a problem hiding this comment.
Adding emojis to distinguish each section: currently, if you scroll quickly through the features, they all look about the same.
PatrickF1
force-pushed
the
readme-overhail
branch
from
4014957 to
0e83f3c
Compare
PatrickF1
added a commit
that referenced
this pull request
Oct 20, 2022
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.