Add setup documentation and finalize configuration

Copilot · bytestream · web-flow · commit 85582b0f163d · 2026-04-07T09:58:52.000Z
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/56c60609-42d5-4470-b53a-8ba170e29227 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
diff --git a/GITHUB_PAGES_SETUP.md b/GITHUB_PAGES_SETUP.md
@@ -0,0 +1,54 @@
+# GitHub Pages Setup Instructions
+
+This document explains how to enable GitHub Pages for this repository.
+
+## Automatic Deployment
+
+The repository is configured to automatically deploy to GitHub Pages using GitHub Actions. The workflow is defined in `.github/workflows/deploy-pages.yml`.
+
+## Enabling GitHub Pages
+
+To enable GitHub Pages for this repository, a repository administrator needs to:
+
+1. Go to the repository **Settings** page
+2. Navigate to **Pages** in the left sidebar
+3. Under **Build and deployment**:
+   - **Source**: Select "GitHub Actions"
+4. Save the changes
+
+## After Enabling
+
+Once GitHub Pages is enabled:
+
+1. The workflow will automatically run when changes are pushed to `main` or `master` branch
+2. You can also manually trigger the workflow from the **Actions** tab
+3. The site will be available at: `https://jquery-validation.github.io/validation-content/`
+   - Or at your custom domain if configured
+
+## Testing the Deployment
+
+After enabling GitHub Pages and pushing changes:
+
+1. Go to the **Actions** tab in the repository
+2. You should see the "Deploy to GitHub Pages" workflow running
+3. Once complete, visit the deployed site URL
+4. Verify that the content displays correctly
+
+## Troubleshooting
+
+If the deployment fails:
+
+1. Check the workflow logs in the **Actions** tab
+2. Verify that GitHub Pages is enabled with "GitHub Actions" as the source
+3. Ensure the branch being deployed (main or master) exists and has the latest changes
+4. Check that all required files are present: `_config.yml`, `_layouts/default.html`, and content files
+
+## Custom Domain (Optional)
+
+To use a custom domain:
+
+1. Add a `CNAME` file to the repository root with your domain name
+2. Configure your DNS settings to point to GitHub Pages
+3. Enable HTTPS in the Pages settings (recommended)
+
+For more information, see: https://docs.github.com/en/pages
diff --git a/_config.yml b/_config.yml
@@ -1,7 +1,7 @@
 title: jQuery Validation Plugin
 description: Site content for the jQuery Validation Plugin
-url: https://jqueryvalidation.org
-baseurl: ""
+url: https://jquery-validation.github.io
+baseurl: "/validation-content"
 
 # Build settings
 markdown: kramdown
@@ -23,6 +23,7 @@ exclude:
   - dist
   - Gemfile
   - Gemfile.lock
+  - GITHUB_PAGES_SETUP.md
 
 # Collections
 collections:
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -71,12 +71,12 @@
 </head>
 <body>
     <header>
-        <h1><a href="/" style="color: #0066cc; text-decoration: none;">{{ site.title }}</a></h1>
+        <h1><a href="{{ site.baseurl }}/" style="color: #0066cc; text-decoration: none;">{{ site.title }}</a></h1>
         <nav>
-            <a href="/">Home</a>
-            <a href="/documentation/">Documentation</a>
-            <a href="/contribute/">Contribute</a>
-            <a href="/reference/">Reference</a>
+            <a href="{{ site.baseurl }}/">Home</a>
+            <a href="{{ site.baseurl }}/documentation/">Documentation</a>
+            <a href="{{ site.baseurl }}/contribute/">Contribute</a>
+            <a href="{{ site.baseurl }}/reference/">Reference</a>
             <a href="https://github.com/jquery-validation/jquery-validation">GitHub</a>
         </nav>
     </header>
diff --git a/index.md b/index.md
@@ -20,8 +20,8 @@ Starting with Version 1.15.0 [Markus Staab](https://github.com/staabm) took over
 ### Files:
 - [Download](https://github.com/jzaefferer/jquery-validation/releases/tag/1.19.5) - zip-Archive with source code, minified and packed version, demos and examples
 - [Changelog](https://github.com/jzaefferer/jquery-validation/releases/tag/1.19.5)
-- [Demos](//jqueryvalidation.org/files/demo/)
-- [Documentation](/documentation/)
+- [Demos](https://jqueryvalidation.org/files/demo/)
+- [Documentation](documentation/)
 - [GitHub Repository](https://github.com/jzaefferer/jquery-validation)
 
 ### Installation via Package Managers
