Refactor configuration to use snake_case for all options, and extract documentation settings to own file #444
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.
Changes to the configuration files
The entire configuration system has been refactored.
Snake_case is used for all configuration keys
All configuration keys are now in the snake_case_format. Published configuration files will need to be updated accordingly. This is pretty fast in a modern code editor like VS Code.
Documentation options have been moved to a new file
The documentation page specific options have been moved to the
config/docs.php
file.You may need to republish Blade views if you have done so before.
This is also easy to do in a modern code editor. See this example of the search and replace I used
to update the codebase:
hyde.docs_sidebar_header_title
=>docs.header_title
Deprecations and removals
The deprecated option named
hyde.docs_directory
has been removed.Use
docs.output_directory
instead.The authors.yml has been deprecated, and will be refactored in an upcoming release.