|
| 1 | +# GitHub Pages Setup Guide |
| 2 | + |
| 3 | +This document provides instructions for enabling GitHub Pages for the AI Story Studio demo. |
| 4 | + |
| 5 | +## Manual Setup Required |
| 6 | + |
| 7 | +Since GitHub Pages configuration requires repository settings changes that cannot be automated through code, follow these steps: |
| 8 | + |
| 9 | +### Step 1: Enable GitHub Pages |
| 10 | +1. Go to your repository settings: `https://github.com/kalosha959-wq/github-mcp-server/settings` |
| 11 | +2. Scroll down to the "Pages" section in the left sidebar |
| 12 | +3. Under "Source", select "GitHub Actions" |
| 13 | +4. The workflow in `.github/workflows/pages.yml` will automatically deploy the site |
| 14 | + |
| 15 | +### Step 2: Access Your Demo |
| 16 | +Once GitHub Pages is enabled and the workflow runs successfully, your AI Story Studio demo will be available at: |
| 17 | + |
| 18 | +- **Main Demo**: `https://kalosha959-wq.github.io/github-mcp-server/ai-story-studio-combined.html` |
| 19 | +- **Index Page**: `https://kalosha959-wq.github.io/github-mcp-server/` |
| 20 | + |
| 21 | +### Step 3: Verify Deployment |
| 22 | +- Check the Actions tab to see the deployment workflow status |
| 23 | +- The first deployment may take 2-5 minutes to become available |
| 24 | +- Subsequent updates will deploy automatically when changes are pushed to the main/master branch |
| 25 | + |
| 26 | +## Files Created |
| 27 | + |
| 28 | +1. **`ai-story-studio-combined.html`** - The main demo application |
| 29 | +2. **`.github/workflows/pages.yml`** - GitHub Pages deployment workflow |
| 30 | +3. **Updated `README.md`** - Documentation with demo links |
| 31 | + |
| 32 | +## Troubleshooting |
| 33 | + |
| 34 | +If the site doesn't load: |
| 35 | +1. Check that GitHub Pages is enabled in repository settings |
| 36 | +2. Verify the Actions workflow completed successfully |
| 37 | +3. Ensure the source is set to "GitHub Actions" (not branch-based deployment) |
| 38 | +4. Wait a few minutes for DNS propagation |
| 39 | + |
| 40 | +## Repository Structure |
| 41 | + |
| 42 | +After implementation, your repository structure includes: |
| 43 | + |
| 44 | +``` |
| 45 | +github-mcp-server/ |
| 46 | +├── ai-story-studio-combined.html # Main demo application |
| 47 | +├── .github/workflows/pages.yml # GitHub Pages deployment |
| 48 | +├── README.md # Updated with demo links |
| 49 | +└── ... (existing MCP server files) |
| 50 | +``` |
| 51 | + |
| 52 | +The demo showcases GitHub MCP Server integration capabilities while maintaining the repository's primary purpose as a Go-based MCP server. |
0 commit comments