Merge pull request #866 from tapyu/tidy-up

concentrate all information concerning the navi settings in `docs/navi_config.md`
denisidoro · Dec 12, 2023 · 6692d6a · 6692d6a
2 parents 430c972 + fa7215e
commit 6692d6a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 63 deletions.
diff --git a/docs/config_file.md b/docs/config_file.md
diff --git a/docs/navi_config.md b/docs/navi_config.md
@@ -1,10 +1,15 @@
+# Paths and Environment Variables
+
+Navi uses the [`directories-next`](https://crates.io/crates/directories-next) package, which 
+defines platform-specific standard locations of directories for config, cache and other data (Mac users, this is why your files are being stored in `~/Library/Application Support/navi`).
+
 ## Config file path
 
 The default config file path is set by the `$NAVI_CONFIG` environment variable. If it is not set, it fallbacks to `~/.config/navi/config.yaml`. The command
 ```sh
 navi info config-path
 ```
-prints which config file path is being used. You can get an config file example by running
+prints which config file path is being used. You can get a config file example by running
 ```sh
 navi info config-example
 ```
@@ -30,3 +35,14 @@ You can also add other paths at runtime by running `navi` with the `--path` opti
 navi --path '/some/dir:/other/dir'
 ```
 It's irrelevant the directory structure within each path. They can even be all in a single file if you wish, as long as you split them accordingly with lines starting with `%`.
+
+Despite `$NAVI_PATH` being set, it will not be used when installing cheat sheets directly via navi's own commands.  For example when running `navi add repo <repo>`, the default paths as per the `directories-next` package will still be used. To avoid this, you may simply clone repos via a regular `git clone` command, directly into `$NAVI_PATH`.
+
+Note! `navi info cheats-path` and `navi info config-path` display the *default* path, not 
+the path set by the user. [It is known that this is a little misleading!](https://github.com/denisidoro/navi/issues/664#issuecomment-1004721178).
+
+# Logging
+
+The log file will be created under the same directory where the config locates.
+
+And you can use the `RUST_LOG` env to set the log level, e.g. `RUST_LOG=debug navi`.
diff --git a/docs/paths_and_env_vars.md b/docs/paths_and_env_vars.md