Merge branch 'master' into feat/release-notes

Author: emmadesilva

.github/workflows/sync-documentation-mirror.yml

@@ -0,0 +1,75 @@
+name: Sync documentation mirror
+
+on:
+  push:
+    branches: [ master, '1.x' ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/sync-documentation-mirror.yml'
+
+# Avoid overlapping runs trying to push at once
+concurrency:
+  group: sync-docs-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  sync:
+    if: github.repository == 'hydephp/develop'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout monorepo
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Determine target subdirectory (1.x vs 2.x)
+        id: vars
+        run: |
+          if [ "${GITHUB_REF_NAME}" = "master" ]; then
+            echo "TARGET_SUBDIR=2.x" >> "$GITHUB_OUTPUT"
+          elif [ "${GITHUB_REF_NAME}" = "1.x" ]; then
+            echo "TARGET_SUBDIR=1.x" >> "$GITHUB_OUTPUT"
+          else
+            echo "Unsupported branch: ${GITHUB_REF_NAME}"
+            exit 78
+          fi
+
+      - name: Clone target repo (hydephp/docs)
+        env:
+          TOKEN: ${{ secrets.DOCS_SYNC_TOKEN }}
+        run: |
+          set -euo pipefail
+          if [ -z "${TOKEN}" ]; then
+            echo "❌ Missing DOCS_SYNC_TOKEN secret with repo access to hydephp/docs."
+            exit 1
+          fi
+          git clone --depth 1 "https://x-access-token:${TOKEN}@github.com/hydephp/docs.git" target-docs
+
+      - name: Replace target directory with monorepo /docs
+        run: |
+          set -euo pipefail
+          DEST="target-docs/${{ steps.vars.outputs.TARGET_SUBDIR }}"
+          # Remove and recreate the target subdir to ensure a full replacement
+          rm -rf "$DEST"
+          mkdir -p "$DEST"
+          # Mirror monorepo docs into the dest (delete removed files)
+          rsync -a --delete --exclude='.git' ./docs/ "$DEST/"
+
+      - name: Commit & push if there are changes
+        env:
+          GIT_AUTHOR_NAME: hydephp-bot
+          GIT_AUTHOR_EMAIL: bot@hydephp.com
+          GIT_COMMITTER_NAME: hydephp-bot
+          GIT_COMMITTER_EMAIL: bot@hydephp.com
+          TOKEN: ${{ secrets.DOCS_SYNC_TOKEN }}
+        run: |
+          set -euo pipefail
+          cd target-docs
+          git add -A
+          if git diff --cached --quiet; then
+            echo "✅ No changes to sync."
+            exit 0
+          fi
+          git commit -m "Sync docs from ${GITHUB_REPOSITORY}@${GITHUB_SHA} (${GITHUB_REF_NAME}) → ${{ steps.vars.outputs.TARGET_SUBDIR }}"
+          # Push to main on hydephp/docs
+          git push origin HEAD:main

_media/app.css

@@ -90,7 +90,7 @@
     |
     | Example: https://github.com/hydephp/docs/blob/master
     |          Do not specify the filename or extension, Hyde will do that for you.
-    | Setting the setting to null will disable the feature.
+    |          Setting this to null will disable the feature.
     |
     */
 

config/docs.php

@@ -138,7 +138,7 @@
     | Site Output Directory
     |--------------------------------------------------------------------------
     |
-    | This setting specifies the output path for your site, useful to for
+    | This setting specifies the output path for your site, useful to, for
     | example, store the site in the docs/ directory for GitHub Pages.
     | The path is relative to the root of your project.
     |
@@ -308,7 +308,7 @@
     |
     | Here you can customize the footer Markdown text for your site.
     |
-    | If you don't want to write Markdown here, you use a Markdown include.
+    | If you don't want to write Markdown here, you can use a Markdown include.
     | You can also customize the Blade view if you want a more complex footer.
     | You can disable it completely by changing the setting to `false`.
     |
@@ -428,7 +428,7 @@
     |
     | Here you can configure settings for the built-in realtime compiler server.
     | The server also includes a magic dashboard feature that supercharges
-    | your local development! This feature can alo be customised here.
+    | your local development! This feature can also be customised here.
     |
     */
 

config/hyde.php

@@ -71,7 +71,7 @@
     |
     | This feature allows you to use basic Laravel Blade in Markdown files.
     |
-    | It's disabled by default since can be a security risk as it allows
+    | It's disabled by default since it can be a security risk as it allows
     | arbitrary PHP to run. But if your Markdown is trusted, try it out!
     |
     | To see the syntax and usage, see the documentation:

config/markdown.php

@@ -1,4 +1,4 @@
-## Automatic Routing
+# Automatic Routing
 
 >info This covers an intermediate topic which is not required for basic usage, but is useful if you want to use the framework to design custom Blade templates.
 
@@ -57,7 +57,7 @@ But where it really shines is when you supply a route. This will then resolve th
 <x-link :href="Routes::get('index')">Home</x-link>
 ```
 
-You can of course, also supply extra attributes like classes:
+You can also supply extra attributes like classes:
 
 ```blade
 <x-link :href="Routes::get('index')" class="btn btn-primary">Home</x-link>

docs/architecture-concepts/automatic-routing.md

@@ -205,7 +205,7 @@ image: image.jpg
 
 #### Full URL
 
-Full URL starting with `http(s)://`) or `//` (protocol-relative).
+Full URL starting with `http(s)://` or `//` (protocol-relative).
 The image source will be used as-is, and no additional processing is done.
 
 ```yaml

docs/creating-content/blog-posts.md

@@ -14,7 +14,7 @@ Hyde compiles your Markdown content into beautiful static HTML pages using a Tai
 
 Additionally, if you have an `_docs/index.md` file, the sidebar header will link to it, and an automatically generated "Docs" link will be added to your site's main navigation menu, pointing to your documentation page.
 
-If you have a Torchlight API token in your `.env` file, Hyde will even enable syntax highlighting automatically, saving you time and effort. For more information about this feature, see the [extensions page](extensions#torchlight).
+If you have a Torchlight API token in your `.env` file, Hyde will even enable syntax highlighting automatically, saving you time and effort. For more information about this feature, see the [extensions page](third-party-integrations#torchlight).
 
 ### Best Practices and Hyde Expectations
 
@@ -241,17 +241,19 @@ To quickly arrange the order of items in the sidebar, you can reorder the page i
 ]
 ```
 
-See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details. <br>
+See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details.
 
 ### Setting Sidebar Group Labels
 
 When using the automatic sidebar grouping feature the titles of the groups are generated from the subdirectory names. If these are not to your liking, for example if you need to use special characters, you can override them in the configuration file. The array key is the directory name, and the value is the label.
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 
-'sidebar_group_labels' => [
-    'questions-and-answers' => 'Questions & Answers',
+'sidebar' => [
+    'labels' => [
+        'questions-and-answers' => 'Questions & Answers',
+    ],
 ],
 ```
 
@@ -264,7 +266,7 @@ By default, each group will be assigned the lowest priority found inside the gro
 Just use the sidebar group key as instead of the page identifier/route key:
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 'sidebar' => [
     'order' => [
         'readme',
@@ -345,7 +347,7 @@ If this setting is set to true, Hyde will output all documentation pages into th
 If you set this to false, Hyde will match the directory structure of the source files (just like all other pages).
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 'flattened_output_paths' => true,
 ```
 
@@ -420,7 +422,7 @@ The feature is automatically enabled when you specify a base URL in the Docs con
 Here's an example configuration from the official HydePHP.com documentation:
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 
 'source_file_location_base' => 'https://github.com/hydephp/docs/blob/master/',
 ```
@@ -430,7 +432,7 @@ Here's an example configuration from the official HydePHP.com documentation:
 Changing the label is easy, just change the following config setting:
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 'edit_source_link_text' => 'Edit Source on GitHub',
 ```
 
@@ -439,7 +441,7 @@ Changing the label is easy, just change the following config setting:
 By default, the button will be shown in the documentation page footer. You can change this by setting the following config setting to `'header'`, `'footer'`, or `'both'`
 
 ```php
-// Filepath: config/docs.php
+// filepath: config/docs.php
 'edit_source_link_position' => 'header',
 ```
 

docs/creating-content/documentation-pages.md

@@ -17,7 +17,7 @@ To get you started quickly, all the styles are already compiled and minified int
 
 ## Vite
 
-Hyde uses [Vite](https://vitejs.dev/) to compile assets. Vite is a build tool that aims to provide a faster and more efficient development experience for modern web projects.
+Hyde uses [Vite](https://vite.dev/) to compile assets. Vite is a build tool that aims to provide a faster and more efficient development experience for modern web projects.
 
 ### Why Vite?
 
@@ -66,6 +66,10 @@ You can check if the Vite HMR server is running with `Vite::running()`, and you
 @endif
 ```
 
+### Laravel Herd
+
+If using Laravel Herd for HydePHP, you can still use Vite by running `npm run dev`. The Herd integration is in public beta, please report any issues to https://github.com/hydephp/realtime-compiler.
+
 ## Additional Information and Answers to Common Questions
 
 ### Is NodeJS/NPM Required for Using Hyde?

docs/creating-content/managing-assets.md

@@ -78,8 +78,8 @@ navigation:
 
 - `label` is the text that will be displayed in the navigation menu
 - `priority` is the order in which the page will appear in the navigation menu (`order` is also supported)
-- `hidden` will hide the page from the navigation menu (`visible`) is also supported, but obviously invert the value)
-- `group` will put the page in a dropdown menu with the specified group name (`category`) is also supported)
+- `hidden` will hide the page from the navigation menu (`visible` is also supported, but obviously invert the value)
+- `group` will put the page in a dropdown menu with the specified group name (`category` is also supported)
 
 ## Creating Blade Pages