Create unified documentation site for commit-check organization #1
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.
This PR creates a comprehensive unified documentation site for the commit-check organization that consolidates documentation from both the main
commit-checktool and thecommit-check-actionGitHub Action into a single, professional hub atcommit-check.github.io.Overview
Previously, documentation was scattered across multiple repositories:
commit-check/commit-checkhad Sphinx-based docs atcommit-check.github.io/commit-check/commit-check/commit-check-actiononly had README-based documentationThis PR establishes
commit-check.github.ioas the central documentation portal for the entire organization.What's Added
🏗️ Jekyll Site Infrastructure
📚 Comprehensive Documentation Structure
🎨 Design & User Experience
🔄 Content Migration & Enhancement
Key Features
Unified Experience: Users can now access all commit-check documentation from a single, professional site rather than navigating between multiple repositories.
Enhanced Discoverability: The site includes cross-references between tools, helping users discover related features (e.g., linking from CLI tool docs to GitHub Action docs).
Improved Onboarding: The Quick Start guide provides immediate value for new users across all integration methods.
Professional Presentation: Custom styling and navigation create a cohesive brand experience for the commit-check organization.
Technical Implementation
The site uses Jekyll with GitHub Pages for automatic deployment. The structure includes:
When merged to main, the site will be automatically deployed to
https://commit-check.github.ioand serve as the official documentation hub for the commit-check organization.This addresses the need for a centralized documentation site as requested in the original issue, providing a single source of truth for all commit-check tools and significantly improving the user experience for developers integrating these tools into their workflows.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.