diff --git a/README.md b/README.md index 9c2702a5..e7ebb1ff 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,8 @@ You can optionally configure yazi.nvim by setting any of the options below. -- the log level to use. Off by default, but can be used to diagnose -- issues. You can find the location of the log file by running - -- `:checkhealth yazi` in Neovim. + -- `:checkhealth yazi` in Neovim. Also check out the "reproducing issues" + -- section below log_level = vim.log.levels.OFF, -- what Neovim should do a when a file was opened (selected) in yazi. @@ -218,3 +219,7 @@ I like. ## Contributing Please see [COMMUNITY.md](./COMMUNITY.md) for more information on the project! + +## In case there are issues + +See [reproducing-issues.md](./documentation/reproducing-issues.md). diff --git a/documentation/reproducing-issues.md b/documentation/reproducing-issues.md index 2013947e..a759ced3 100644 --- a/documentation/reproducing-issues.md +++ b/documentation/reproducing-issues.md @@ -13,3 +13,23 @@ provide a fix. To help us diagnose the issue, please follow these steps: similar to your configuration until you can reproduce it. 4. when reporting the issue, attach the contents of your `repro.lua` file to the issue report. + +## Logging + +You can find out a lot of details about what is going on in yazi.nvim by reading +the log file. To find the log file, execute + +```vim +:checkhealth yazi +``` + +It will show where your log file is. It's recommended to "tail" the log file to +see any new messages as soon as they arrive: + +```sh +tail -F /path/to/logfile +``` + +If you want to get fancy, you can use the command line program +[bat's custom tailing](https://github.com/sharkdp/bat?tab=readme-ov-file#tail--f) +instructions to get colored output.