Skip to content

Add GitHub Pages workflow and improve deployment documentation - #9

Merged
Stealinglight merged 1 commit into
mainfrom
docs/add-github-pages-workflow
Jan 18, 2026
Merged

Stealinglight merged 1 commit into
mainfrom
docs/add-github-pages-workflow

Conversation

@Stealinglight

Copy link
Copy Markdown
Owner

Summary

This PR fixes the missing GitHub Pages deployment and improves the deployment documentation to make AWS setup clearer.

Changes

GitHub Actions Workflows

  • ✅ deploy-docs.yml - Automatically deploys documentation to GitHub Pages
  • ✅ deploy-lambda.yml - Optional CI/CD pipeline for Lambda deployment
  • ✅ workflows/README.md - Complete documentation for all workflows

Documentation Updates

  • ✅ Enhanced README prerequisites with detailed AWS setup steps
  • ✅ Added verification commands for AWS CLI and SAM
  • ✅ Improved deployment instructions (first-time vs subsequent)
  • ✅ Expanded troubleshooting section

Configuration

  • ✅ Added samconfig.toml template for faster re-deployments

Problem Solved

Before: Documentation site showed 404 error - no workflow to deploy docs
After: Automatic deployment to GitHub Pages on every push to main

Testing

  • Verified workflow YAML syntax
  • Tested README changes render correctly
  • Confirmed samconfig.toml format is- [x] Confirmed samconfig.toml format is- [x] Confirmed samconfig.toml format is- [x] Confirmed samconfig.toml formatto - [x] Contealinglight.github.io/StravaMCP
  1. First deployment takes 2-3 minutes
  2. Subsequent doc updates deploy automatically

Closes #404 (documentation not accessible)

- Add deploy-docs.yml workflow for automatic documentation deployment
- Add deploy-lambda.yml workflow for optional Lambda CI/CD
- Add workflows README documenting all GitHub Actions
- Update main README with detailed AWS setup prerequisites
- Improve deployment instructions with first-time vs subsequent workflows
- Add troubleshooting section for common setup issues

Fixes missing GitHub Pages deployment (resolves #404 on docs site)
@Stealinglight
Stealinglight merged commit 4987764 into main Jan 18, 2026
1 check failed
@Stealinglight
Stealinglight deleted the docs/add-github-pages-workflow branch January 18, 2026 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

⌂ 换网址