Refactor documentation sidebar internals #299
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[ci skip] [skip ci]
Apply fixes from StyleCI
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refactor the documentation page sidebar generator to be more stable and manageable.
Previously, the sidebar was generated in an action and resulted in an array that was hard to manage.
Now, the sidebar generation is done in a service class, and creates two models. First, a sidebar model that extends the illuminate collection and contains all the sidebar items, which in turn are models as well.
Using collections instead of an array allows for higher level management such as filtering and ordering. Having each item as an object also allows for a more predictable state.
It will fix #282, and since priorities can now be set in front matter, it will also fix #169.