Skip to content

feat: Add GitHub Pages deployment for docs/ directory#16

Merged
rezacute merged 1 commit intomainfrom
v02-01-in-memory-broker
Jul 26, 2025
Merged

feat: Add GitHub Pages deployment for docs/ directory#16
rezacute merged 1 commit intomainfrom
v02-01-in-memory-broker

Conversation

@rezacute
Copy link
Owner

FEATURE: Deploy comprehensive documentation site to GitHub Pages

Problem:

  • Only API docs (cargo doc) were being deployed to GitHub Pages
  • Rich documentation in docs/ directory (examples, guides, etc.) not accessible
  • Users couldn't access comprehensive documentation with examples

Solution:
✅ Created ci-and-docs.yml workflow:

  • Combines CI checks (formatting, compilation) with docs deployment
  • Uses Jekyll to build the docs/ directory
  • Deploys to GitHub Pages on main branch pushes
  • Proper Ruby/Jekyll setup with bundler caching

✅ Documentation Structure:

  • docs/index.md - Main homepage
  • docs/docs/getting-started.md - Getting started guide
  • docs/examples/ - Comprehensive examples (13,600+ lines)
    • in-memory.md, rabbitmq.md, kafka.md, mqtt.md
    • acknowledgments.md, routing.md, and more
  • Jekyll configuration with proper styling
  • Navigation and responsive design

✅ Workflow Features:

  • CI checks: formatting and compilation
  • Jekyll build with proper baseurl handling
  • GitHub Pages deployment with proper permissions
  • Only deploys on main branch (not PRs)
  • Caching for faster builds

✅ Expected Result:

  • https://rezacute.github.io/kincir/ will show the full documentation site
  • Users can access examples, guides, and comprehensive docs
  • Professional documentation experience vs just API docs

✅ Disabled Workflows:

  • ultra-simple-ci.yml → ultra-simple-ci.yml.disabled
  • Focused on single comprehensive workflow

The documentation site will now showcase the full Kincir documentation including all the comprehensive examples and guides we created.


name: Pull Request
about: Propose changes to the Kincir codebase
title: '' # Let the user fill this
labels: '' # Let the user or maintainers add labels
assignees: '' # Let the user or maintainers assign

Description
Please include a summary of the change and which issue is fixed (if any). For example: Fixes #123.
Please also include relevant motivation and context.

Type of change
Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Chore (refactoring, build improvements, tooling, etc.)

How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

  • New unit tests added
  • Existing unit tests pass
  • New integration tests added
  • Existing integration tests pass
  • Manual testing (please describe steps)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Screenshots (if applicable)
If your change has a visual component, please include screenshots.

Additional context
Add any other context about the pull request here.

FEATURE: Deploy comprehensive documentation site to GitHub Pages

Problem:
- Only API docs (cargo doc) were being deployed to GitHub Pages
- Rich documentation in docs/ directory (examples, guides, etc.) not accessible
- Users couldn't access comprehensive documentation with examples

Solution:
✅ Created ci-and-docs.yml workflow:
- Combines CI checks (formatting, compilation) with docs deployment
- Uses Jekyll to build the docs/ directory
- Deploys to GitHub Pages on main branch pushes
- Proper Ruby/Jekyll setup with bundler caching

✅ Documentation Structure:
- docs/index.md - Main homepage
- docs/docs/getting-started.md - Getting started guide
- docs/examples/ - Comprehensive examples (13,600+ lines)
  - in-memory.md, rabbitmq.md, kafka.md, mqtt.md
  - acknowledgments.md, routing.md, and more
- Jekyll configuration with proper styling
- Navigation and responsive design

✅ Workflow Features:
- CI checks: formatting and compilation
- Jekyll build with proper baseurl handling
- GitHub Pages deployment with proper permissions
- Only deploys on main branch (not PRs)
- Caching for faster builds

✅ Expected Result:
- https://rezacute.github.io/kincir/ will show the full documentation site
- Users can access examples, guides, and comprehensive docs
- Professional documentation experience vs just API docs

✅ Disabled Workflows:
- ultra-simple-ci.yml → ultra-simple-ci.yml.disabled
- Focused on single comprehensive workflow

The documentation site will now showcase the full Kincir documentation
including all the comprehensive examples and guides we created.
@rezacute rezacute merged commit 81a4113 into main Jul 26, 2025
4 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.

1 participant