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

Breaking refactor to further unify sidebar and navigation API #498

Merged
merged 60 commits into from
Sep 12, 2022

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented Sep 11, 2022

This PR will breakingly remove the DocumentationPage::$category property and use HydePage::$navigation['group]' instead. This will require existing documentation pages to update their front matter. However, in the end this will become more consistent and match #495.

In addition and similar to the reasons in the original PR; further arguments for this change is that the naming is also inconsistent when it comes to sidebar categories and groups, for example the important DocumentationSidebar.php uses the term group exclusively, yet the front matter property is named category. Same in the NavItem class and many more places I'm sure I'll discover as I refactor this. Even the Blade views use the term groups.

@codecov
Copy link

codecov bot commented Sep 11, 2022

Codecov Report

Merging #498 (a3f2022) into master (6d65654) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##             master     #498   +/-   ##
=========================================
  Coverage     99.95%   99.95%           
- Complexity      927      929    +2     
=========================================
  Files           107      108    +1     
  Lines          2284     2300   +16     
=========================================
+ Hits           2283     2299   +16     
  Misses            1        1           
Impacted Files Coverage Δ
...rk/src/Concerns/Internal/ConstructsPageSchemas.php 100.00% <ø> (ø)
...s/framework/src/Models/Pages/DocumentationPage.php 100.00% <ø> (ø)
packages/framework/src/Concerns/HydePage.php 100.00% <100.00%> (ø)
.../src/Concerns/Internal/GeneratesNavigationData.php 100.00% <100.00%> (ø)
...ckages/framework/src/Models/Navigation/NavItem.php 100.00% <100.00%> (ø)
packages/framework/src/Models/NavigationData.php 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@caendesilva caendesilva marked this pull request as ready for review September 12, 2022 08:26
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