docs: Add bash-it doctor and logs documentation

This commit is contained in:
Noah Gorny
2020-06-20 20:36:12 +03:00
parent 1e674643b3
commit 862c154793
2 changed files with 23 additions and 0 deletions

View File

@@ -2,6 +2,15 @@
This page summarizes a couple of rules to keep in mind when developing features or making changes in Bash-it.
## Debugging and Logging
While developing feature or making changes in general, you can log error/warning/debug
using `_log_error` `_log_warning` and `_log_debug`. This will help you solve problems quicker
and also propagate important notes to other users of Bash-it.
You can see the logs by using `bash-it doctor` command to reload and see the logs.
Alternatively, you can set `BASH_IT_LOG_LEVEL` to `BASH_IT_LOG_LEVEL_ERROR`, `BASH_IT_LOG_LEVEL_WARNING` or `BASH_IT_LOG_LEVEL_ALL`.
## Load Order
### General Load Order