[2.x] Clean up the navigation and sidebar documentation #1838
Conversation
This reverts commit 901b810.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unify-the-navigation-api #1838 +/- ##
============================================================
Coverage ? 100.00%
Complexity ? 1855
============================================================
Files ? 190
Lines ? 4909
Branches ? 0
============================================================
Hits ? 4909
Misses ? 0
Partials ? 0 ☔ View full report in Codecov by Sentry. |
…sidebar Matches writing style, and is more intuitive
|
|
||
| ```yaml | ||
| navigation: | ||
| priority: 5 | ||
| ``` | ||
|
|
||
| You can also change the order in the Docs configuration file. See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details. <br> | ||
| _I personally think the config route is easier as it gives an instant overview, however the first way is nice as well._ | ||
| You can also change the order in the `config/docs.php` configuration file, which may be easier to manage for larger sites. See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details. |
There was a problem hiding this comment.
This chapter does no longer have this information:
Navigation Menu & Sidebar
A great time-saving feature of HydePHP is the automatic navigation menu and documentation sidebar generation.
Hyde is designed to automatically configure these menus for you based on the content you have in your project.Still, you will likely want to customize some parts of these menus, and thankfully, Hyde makes it easy to do so.
Customizing the navigation menu
- To customize the navigation menu, use the setting
navigation.orderin thehyde.phpconfig.- When customizing the navigation menu, you should use the route key of the page.
Learn more in the Navigation Menu documentation.
Customizing the documentation sidebar
- To customize the sidebar, use the setting
sidebar.orderin thedocs.phpconfig.- When customizing the sidebar, can use the route key, or just the page identifier of the page.
Learn more in the Documentation Pages documentation.
caendesilva
changed the title
Part of #1818