Skip to content

GITHUB_PAGES_DEPLOYMENT.md

Latest commit

 

History

History
59 lines (45 loc) · 2.25 KB

GITHUB_PAGES_DEPLOYMENT.md

File metadata and controls

59 lines (45 loc) · 2.25 KB
Raw

GitHub Pages Deployment Summary

Website Details

  • Live URL: https://phmatray.github.io/FormCraft/
  • Content: Interactive Blazor WebAssembly demo application with full documentation
  • Auto-deployment: Triggered on every push to main branch

Features Available on the Website

Interactive Demo Pages

  • Home: Welcome page with overview
  • Simplified API: Basic form examples
  • Type-Safe Builder: Advanced form configuration
  • Fluent API: Demonstration of fluent interface
  • Field Groups: Organized form sections
  • Custom Renderers: Color picker and rating controls
  • File Upload: Single and multiple file upload examples

Documentation

  • Getting Started: Installation and basic usage
  • API Reference: Complete method documentation
  • Examples: Code samples and use cases
  • Customization: Creating custom renderers and validators
  • Troubleshooting: Common issues and solutions

Updated References

The following files have been updated to include the new website:

Main Documentation

  • README.md - Added live demo link and updated documentation links
  • FormCraft/README.md - Added demo and documentation links
  • FormCraft/FormCraft.csproj - Updated package description with demo URL
  • CONTRIBUTING.md - Added demo link for contributors

Build and Deployment

  • .github/workflows/deploy-docs.yml - GitHub Actions workflow for automatic deployment
  • FormCraft.DemoBlazorApp/ - Converted to Blazor WebAssembly
  • wwwroot/404.html - SPA routing support for GitHub Pages
  • wwwroot/.nojekyll - Prevents Jekyll processing

Benefits

  1. Live Demonstrations: Users can try FormCraft features without installing
  2. Interactive Documentation: Documentation with working examples
  3. Better Discovery: Improved SEO and discoverability
  4. Community Engagement: Easier for potential contributors to understand the project
  5. Professional Presence: Enhanced project credibility

Maintenance

The website automatically updates when changes are pushed to the main branch. The deployment workflow:

  1. Builds the Blazor WebAssembly application
  2. Updates base href for GitHub Pages
  3. Deploys to the gh-pages branch
  4. GitHub Pages serves the content

No manual intervention is required for updates.