Skip to content

Conversation

@GiggleLiu
Copy link
Member

Summary

Fixes the 404 error on the documentation site (https://giggleliu.github.io/BPDecoderPlus/) by modernizing the GitHub Pages deployment workflow.

Problem

The previous workflow used mkdocs gh-deploy --force which:

  1. Built the docs locally
  2. Pushed to gh-pages branch using git

However, this approach had configuration issues with GitHub Pages resulting in 404 errors.

Solution

Updated the workflow to use the modern GitHub Pages deployment approach:

  1. Build the documentation: Run mkdocs build to generate the site
  2. Upload as artifact: Use actions/upload-pages-artifact@v3 to upload the built site
  3. Deploy with official action: Use actions/deploy-pages@v4 for deployment

Also updated:

  • ✅ Added proper permissions (pages: write, id-token: write)
  • ✅ Added github-pages environment configuration
  • ✅ Added concurrency control to prevent deployment conflicts
  • ✅ Updated GitHub Pages settings to use the correct source

Testing

After merging this PR, the documentation will be automatically deployed and should be accessible at https://giggleliu.github.io/BPDecoderPlus/

References

🤖 Generated with Claude Code

This commit fixes the 404 error on the documentation site by updating the deployment workflow to use the modern GitHub Pages deployment actions.

Changes:
- Switched from `mkdocs gh-deploy` to building and deploying via GitHub Actions
- Added proper permissions for pages deployment (pages: write, id-token: write)
- Added github-pages environment configuration
- Using actions/configure-pages, actions/upload-pages-artifact, and actions/deploy-pages for deployment

This approach is the recommended way to deploy to GitHub Pages with GitHub Actions.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@GiggleLiu GiggleLiu merged commit a33645d into main Jan 20, 2026
3 checks passed
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.

2 participants