feat: Add GitHub Pages deployment for docs/ directory#16
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
FEATURE: Deploy comprehensive documentation site to GitHub Pages
Problem:
Solution:
✅ Created ci-and-docs.yml workflow:
✅ Documentation Structure:
✅ Workflow Features:
✅ Expected Result:
✅ Disabled Workflows:
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.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Checklist:
Screenshots (if applicable)
If your change has a visual component, please include screenshots.
Additional context
Add any other context about the pull request here.