Skip to content

Commit

Permalink
docs: add more details to the quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Jan 30, 2024
1 parent 8165370 commit cb7a33a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 10 deletions.
10 changes: 1 addition & 9 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ If you don't want to use it and want things to be calm, sure, you can modify the

```toml
[status]
separator_open = ""
separator_open = ""
separator_close = ""

[icon]
Expand All @@ -115,11 +115,3 @@ If you find that the XXX feature is missing, please check if it has already been
Our time slices are limited, and they are allocated to what we consider critical issues, such as bug fixes and making Yazi stable, which includes addressing proposals that could potentially lead to broken changes in the future.

Most maintainers have their full-time jobs, so please understand if your request isn't implemented promptly. Of course, we welcome any constructive PR to help expedite the implementation of your desired feature!

## Why do I need to copy the entire keybindings?

Quoted from [sxyazi/yazi#158 - comment](https://github.com/sxyazi/yazi/issues/158#issuecomment-1722130381):

> Since Yazi is still in the alpha stage and is not yet stable, default keybindings may undergo adjustments, potentially disrupting user expectations.
>
> Therefore, I encourage users to copy the complete keybinding list, which will not be affected by default configurations. Considering a merge after Yazi stabilizes seems to make more sense.
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ function ya {
</TabItem>
</Tabs>
To use it, copy the function into the configuration file of your respective shell.
To use it, copy the function into the configuration file of your respective shell. Then use `ya` instead of `yazi` to start.
## Keybindings
Expand Down

0 comments on commit cb7a33a

Please sign in to comment.