update

Author: rushhiii

.github/workflows/deploy.yml

@@ -6,9 +6,18 @@ on:
   pull_request:
     branches: [ main ]
 
+# Add permissions for GITHUB_TOKEN
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
     - name: Checkout repository
@@ -28,10 +37,17 @@ jobs:
     - name: Build documentation
       run: npm run docs:build
 
-    - name: Deploy to GitHub Pages
+    - name: Setup Pages
+      if: github.ref == 'refs/heads/main'
+      uses: actions/configure-pages@v4
+      
+    - name: Upload artifact
       if: github.ref == 'refs/heads/main'
-      uses: peaceiris/actions-gh-pages@v3
+      uses: actions/upload-pages-artifact@v3
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/.vitepress/dist
-        cname: # Add your custom domain here if you have one
+        path: docs/.vitepress/dist
+        
+    - name: Deploy to GitHub Pages
+      if: github.ref == 'refs/heads/main'
+      id: deployment
+      uses: actions/deploy-pages@v4

GITHUB_PAGES_SETUP.md

@@ -0,0 +1,62 @@
+# GitHub Pages Setup Instructions
+
+## 🚀 Quick Setup for GitHub Pages Deployment
+
+After pushing the updated workflow, you need to configure GitHub Pages in your repository settings:
+
+### Step 1: Enable GitHub Pages
+
+1. Go to your repository on GitHub: `https://github.com/rushhiii/Scriptable-IOSWidgets`
+2. Click on **Settings** tab
+3. Scroll down to **Pages** section in the left sidebar
+4. Click on **Pages**
+
+### Step 2: Configure Pages Source
+
+1. Under **Source**, select **GitHub Actions** (not Deploy from a branch)
+2. This tells GitHub to use the workflow we created instead of looking for a gh-pages branch
+
+### Step 3: Verify Deployment
+
+1. Push your changes to the main branch
+2. Go to **Actions** tab in your repository
+3. Watch the "Deploy VitePress Documentation" workflow run
+4. Once complete, your site will be available at: `https://rushhiii.github.io/Scriptable-IOSWidgets/`
+
+## 🔧 What Was Fixed
+
+### Previous Issues:
+- ❌ Missing permissions for GITHUB_TOKEN
+- ❌ Using deprecated peaceiris/actions-gh-pages@v3
+- ❌ No proper environment configuration
+
+### Solutions Applied:
+- ✅ Added proper permissions (`contents: read`, `pages: write`, `id-token: write`)
+- ✅ Updated to use official GitHub Pages actions
+- ✅ Added environment configuration for better security
+- ✅ Using modern `actions/deploy-pages@v4`
+
+## 📝 Updated Workflow Features
+
+- **Automatic Deployment**: Deploys on every push to main branch
+- **Security**: Uses GitHub's official Pages deployment actions
+- **Reliability**: Modern actions with better error handling
+- **URL Output**: Provides the deployed site URL after successful deployment
+
+## 🌐 Expected Site URL
+
+Your documentation will be available at:
+```
+https://rushhiii.github.io/Scriptable-IOSWidgets/
+```
+
+## 🔍 Troubleshooting
+
+If the deployment still fails:
+
+1. **Check Repository Settings**: Ensure Pages source is set to "GitHub Actions"
+2. **Verify Workflow**: Check the Actions tab for detailed error logs
+3. **Repository Permissions**: Make sure your account has admin access to the repository
+4. **Branch Protection**: Ensure main branch allows Actions to run
+
+The workflow should now deploy successfully! 🎉