GITHUB_PAGES_SETUP.md•2.58 kB
# GitHub Pages Setup Instructions
## Step 1: Create GitHub Repository
1. Go to https://github.com/worksona
2. Click "New repository"
3. Repository name: `worksona-mcp-server`
4. Description: `Production-ready MCP server for Claude Desktop with 86+ specialized AI agents`
5. Make it **Public** (required for GitHub Pages on free plan)
6. **Do NOT** initialize with README (we already have one)
7. Click "Create repository"
## Step 2: Push to GitHub
Run these commands:
```bash
cd /Users/davidolsson/WORKSONA/worksona-mcp-server-local
# Add the remote repository
git remote add origin https://github.com/worksona/worksona-mcp-server.git
# Push the main branch
git push -u origin main
```
## Step 3: Enable GitHub Pages
1. Go to your repository: `https://github.com/worksona/worksona-mcp-server`
2. Click **Settings** (top right)
3. In the left sidebar, click **Pages**
4. Under "Build and deployment":
- **Source**: Select "GitHub Actions"
5. Save the settings
## Step 4: Trigger Deployment
The GitHub Actions workflow will automatically deploy when you push changes to:
- `site/**`
- `agents/**`
- `generate-site-data.js`
- `build-site.sh`
To manually trigger deployment:
1. Go to the **Actions** tab
2. Click "Deploy Site to GitHub Pages" workflow
3. Click "Run workflow" → "Run workflow"
## Step 5: Access Your Site
Your site will be available at:
**https://worksona.github.io/worksona-mcp-server/**
## Deployment Status
Check deployment status in:
- **Actions** tab: See build/deploy progress
- **Settings → Pages**: See deployment URL and status
## Future Updates
Whenever you push changes to the main branch that affect the site, GitHub Actions will automatically:
1. Generate agent data
2. Build the site
3. Deploy to GitHub Pages
---
## Current Status
✅ Git repository initialized
✅ Main branch created
✅ Initial commit completed (229 files, 52,330 lines)
✅ GitHub Actions workflow configured
⏳ Waiting for GitHub repository creation and push
⏳ Waiting for GitHub Pages enablement
---
## Site Features
Your microsite includes:
- **Agent Directory**: Browse 86 agents across 18 categories
- **Documentation**: Prerequisites, installation, usage, API reference
- **Examples**: 5 real-world use cases with copy buttons
- **Flat Design**: Minimalist, mobile-ready interface
- **Interactive**: Copy buttons on all code snippets
- **Fast**: Optimized static site generation
## Technical Stack
- Static HTML/CSS/JavaScript
- No build dependencies for hosting
- GitHub Actions for CI/CD
- Automatic agent data generation
- SEO optimized