docs: fix config loading order documentation to match implemen… #566
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation Fix for Configuration Loading Order
This PR updates the documentation to accurately reflect the actual configuration loading order as implemented in the code.
Issue
The documentation incorrectly described the configuration loading order, particularly omitting the repository-specific config file lookup and incorrectly stating the default path when no environment variables are set.
Changes
Updated documentation to match the actual implementation in
config/parser.go
:The loading order is now documented as:
$GH_DASH_CONFIG
environment variable first.gh-dash.yml
or.gh-dash.yaml
in the repo root$XDG_CONFIG_HOME/gh-dash/config.yml
if XDG_CONFIG_HOME is set$HOME/.config/gh-dash/config.yml
on Linux/macOS or%USERPROFILE%\.config\gh-dash\config.yml
on Windows