website(docs): Enhance the documentation for the config-path option #4294
Conversation
|
|
||
| > **Important**: when passing `--config-path`, the auto discovery of the `rome.json` configuration file is disabled. |
There was a problem hiding this comment.
Something that I wanted to highlight, was also the fact that when this option is passed, Rome will abort if the configuration is not found. This is different from the default behaviour.
There was a problem hiding this comment.
I highlighted the auto discovery feature in the introduction header of the configuration page too. Please take a lookm and I updated the introduction text so that it starts with talking about what configuration is first (Rome has a default configuration) and then mentions the rome.json configuration file in the second paragraph.
There was a problem hiding this comment.
I changed the wording to Important: ... primarily because using the --config-path option is not bad per-se (a warning is bad).
Enhances the documentation for the new config-path option and defuses some strong wording (
Warning-> Important).Related