General HydePHP v2.0 Discussion

[caendesilva]

Abstract

Creating this discussion to track and share ideas on HydePHP v2.0. While breaking changes should still be avoided whenever possible, major version bumps is the only opportunity to do so. As we roll out backwards compatible features in minor releases, the major bumps are mainly for the features that can be breaking.

Feature ideas

Here is what I want to do for v2.0

• Refactor navigation internals to better unify the configuration API and reduce discrepancies with the sidebar code
• Refactor how documentation search is handled, to use InMemoryPages instead of build tasks
• InMemoryPages should not be support having the getSourcePath method called, as they don't have source paths. We may instead want to throw an exception, or simply return null, or an empty string. Edit: This will cause issues since the PageCollection indexes pages by their source path.
• The sitemap should not be generated when there are no pages
• Consider not copying app.css when using the CDN (and no files reference it?)
• Normalize realtime compiler API routes, for example, moving the dashboard to _dashboard or _hyde/dashboard? To prevent conflicts.

Timeline

We would probably want to release the next version along with the Laravel 11 release, in case we want to tie in with new possibly breaking features then. Laravel 11 is scheduled to be released February 6th, 2024. Considering we need a little time to upgrade, a good plan is to release v2 in March 2024, which coincidentally is one year after v1.0 which is nice. So let's aim for a Q1 release.