Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor configuration to use snake_case for all options, and extract documentation settings to own file #444

Merged
merged 17 commits into from
May 22, 2022

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented May 22, 2022

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.

@caendesilva caendesilva merged commit 173b208 into master May 22, 2022
@caendesilva caendesilva deleted the refactor-configs branch May 22, 2022 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants