From 0dd7b4c9f2d64ccb95707066445a85e4f1ee501e Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 21:03:10 +0100 Subject: [PATCH] docs: extra clarity --- docs/paths_and_environment_variables.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md index 99eb490..f0cdbb9 100644 --- a/docs/paths_and_environment_variables.md +++ b/docs/paths_and_environment_variables.md @@ -12,7 +12,7 @@ environment variables: export NAVI_CONFIG="~/.config/navi/config.yaml" export NAVI_PATH="~/.local/share/navi" ``` -Note! Even when set, `$NAVI_PATH` will not be used when installing cheat +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 `, the default paths as per the `directories-next` @@ -20,3 +20,6 @@ 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).