Update website for HydePHP v2#118
Conversation
Upgrade to HydePHP v2
Dual documentation versions
|
A live preview is being deployed! |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the HydePHP documentation website for version 2, making extensive changes across multiple documentation files to transition from version 1.x to 2.x. The changes primarily focus on updating links, UI improvements, and modernizing the site structure.
Key changes include:
- Updated version references from HydePHP 1.8.0 to 2.0.0-RC.4
- Systematic conversion of documentation links from 1.x to 2.x format (adding .html extensions)
- Enhanced mobile navigation with improved hamburger menu implementation
- Complete replacement of search functionality with new Alpine.js-based system
Reviewed Changes
Copilot reviewed 97 out of 346 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/1.x/blade-page-methods.html | Updated version references, links to 2.x docs, enhanced navigation menu, and replaced search system |
| docs/docs/1.x/base-markdown-page-methods.html | Similar updates with version bump, link corrections, and search system replacement |
| docs/docs/1.x/automatic-routing.html | Version updates, documentation link fixes, improved table of contents styling |
| docs/docs/1.x/autodiscovery.html | Comprehensive updates including version references, enhanced ToC structure, and search improvements |
| docs/docs/1.x/architecture-concepts.html | Version updates, link corrections, and UI improvements for navigation and search |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| <a href="#content" id="skip-to-content" class="sr-only focus:not-sr-only bg-black border-4 border-yellow-400 focus:absolute focus:mt-2 focus:mx-auto focus:p-2 focus:w-64 h-auto left-0 overflow-auto right-0 rounded-md text-center text-lg text-white top-auto z-50 ">Skip to content</a> <nav id="mobile-navigation" class="bg-white dark:bg-gray-800 md:hidden flex justify-between w-full h-16 z-40 fixed left-0 top-0 p-4 leading-8 shadow-lg print:hidden"> | ||
| <strong class="px-2 mr-auto"> | ||
| <a href="../../docs/1.x/"> | ||
| <a href="../../docs/2.x/index.html"> |
There was a problem hiding this comment.
The navigation links are inconsistently updated - some point to 2.x while the current page remains in the 1.x directory structure. This creates confusion as users are navigating from 1.x pages to 2.x links. Consider either updating the current page structure or ensuring all navigation links maintain consistency within the same version.
| <a href="../../docs/2.x/index.html"> | |
| <a href="../../docs/1.x/index.html"> |
|
|
||
|
|
||
| <link rel="canonical" href="https://hydephp.com/docs/1.x/blade-page-methods"> | ||
| <link rel="canonical" href="https://hydephp.com/docs/1.x/blade-page-methods.html"> |
There was a problem hiding this comment.
The canonical URL still points to 1.x while other navigation elements point to 2.x. This mixed versioning could negatively impact SEO and create user confusion about which version they're viewing.
| <link rel="canonical" href="https://hydephp.com/docs/1.x/blade-page-methods.html"> | |
| <link rel="canonical" href="https://hydephp.com/docs/2.x/blade-page-methods.html"> |
| Alpine.data('hydeSearch', () => | ||
| initHydeSearch('../../docs/1.x/search.json') | ||
| ); |
There was a problem hiding this comment.
The search functionality is still configured to use 1.x search index while navigation points to 2.x documentation. This will result in search results that don't match the linked documentation version.
| // Compiled file: _site/docs/readme.html | ||
| Routes::get('docs/readme') | ||
| </code></pre> | ||
| <h3 id="using-the-code-x-link-code-component" class="group w-fit scroll-mt-2">Using the <code>x-link</code> component<a href="#using-the-code-x-link-code-component" class="heading-permalink opacity-0 ml-1 transition-opacity duration-300 ease-linear px-1 group-hover:opacity-100 focus:opacity-100 group-hover:grayscale-0 focus:grayscale-0" title="Permalink">#</a></h3> |
There was a problem hiding this comment.
The heading ID contains 'code-' prefixes that will break anchor links. The ID should be 'using-the-x-link-component' to match the expected anchor format.
| <h3 id="using-the-code-x-link-code-component" class="group w-fit scroll-mt-2">Using the <code>x-link</code> component<a href="#using-the-code-x-link-code-component" class="heading-permalink opacity-0 ml-1 transition-opacity duration-300 ease-linear px-1 group-hover:opacity-100 focus:opacity-100 group-hover:grayscale-0 focus:grayscale-0" title="Permalink">#</a></h3> | |
| <h3 id="using-the-x-link-component" class="group w-fit scroll-mt-2">Using the <code>x-link</code> component<a href="#using-the-x-link-component" class="heading-permalink opacity-0 ml-1 transition-opacity duration-300 ease-linear px-1 group-hover:opacity-100 focus:opacity-100 group-hover:grayscale-0 focus:grayscale-0" title="Permalink">#</a></h3> |
| </li> | ||
| </ul> | ||
| </li> <li class="sidebar-item -ml-4 pl-4" role="listitem"> | ||
| <a href="../../docs/1.x/documentation-page-methods" class="-ml-8 pl-4 py-1 px-2 block border-l-[0.325rem] border-transparent transition-colors duration-300 ease-in-out hover:bg-black/10"> |
There was a problem hiding this comment.
This link is missing the .html extension while other similar links in the same file have been updated to include it. This inconsistency could result in broken links.
| <a href="../../docs/1.x/documentation-page-methods" class="-ml-8 pl-4 py-1 px-2 block border-l-[0.325rem] border-transparent transition-colors duration-300 ease-in-out hover:bg-black/10"> | |
| <a href="../../docs/1.x/documentation-page-methods.html" class="-ml-8 pl-4 py-1 px-2 block border-l-[0.325rem] border-transparent transition-colors duration-300 ease-in-out hover:bg-black/10"> |
Need to go over issues and check canonicals later