Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 17, 2025

This PR creates a comprehensive unified documentation site for the commit-check organization that consolidates documentation from both the main commit-check tool and the commit-check-action GitHub Action into a single, professional hub at commit-check.github.io.

Overview

Previously, documentation was scattered across multiple repositories:

  • commit-check/commit-check had Sphinx-based docs at commit-check.github.io/commit-check/
  • commit-check/commit-check-action only had README-based documentation

This PR establishes commit-check.github.io as the central documentation portal for the entire organization.

What's Added

🏗️ Jekyll Site Infrastructure

  • Complete Jekyll-based documentation site with GitHub Pages deployment
  • Custom responsive theme with professional navigation
  • Automated deployment workflow using GitHub Actions
  • SEO optimization with sitemap generation and proper meta tags

📚 Comprehensive Documentation Structure

  • Landing Page: Overview of all commit-check tools with quick access links
  • Quick Start Guide: Step-by-step setup for GitHub Actions, local development, and Git hooks
  • Commit Check Tool Documentation (3 pages):
    • Main documentation with usage examples and configuration
    • Detailed CLI arguments reference
    • Comprehensive configuration guide with examples
  • GitHub Action Documentation (2 pages):
    • Complete usage guide with workflow examples
    • Troubleshooting guide for common issues
  • 404 Error Page: User-friendly error handling

🎨 Design & User Experience

  • Responsive navigation bar with current page highlighting
  • Custom CSS styling that matches GitHub's design language
  • Code syntax highlighting for all examples
  • Cross-referenced links between related tools and features
  • Mobile-friendly responsive design

🔄 Content Migration & Enhancement

  • Converted existing RestructuredText documentation to Markdown
  • Enhanced commit-check tool documentation with additional guides
  • Expanded GitHub Action documentation beyond the original README
  • Added practical examples and troubleshooting scenarios
  • Maintained all existing badges, links, and external references

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:

  • Custom layouts and includes for consistent theming
  • SCSS styling for enhanced visual design
  • Proper permalink structure for SEO
  • Comprehensive GitHub Actions workflow for CI/CD

When merged to main, the site will be automatically deployed to https://commit-check.github.io and 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.

Copilot AI and others added 3 commits September 17, 2025 01:25
…mit-check-action docs

Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
…nced styling

Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
Copilot AI changed the title [WIP] I want this doc site to include the existing doc from https://commit-check.github.io/commit-check/ (repo is https://github.com/commit-check/commit-check) and also add a doc for repo https://github.com/commit-check/commit-check-action, so that the commi... Create unified documentation site for commit-check organization Sep 17, 2025
Copilot AI requested a review from shenxianpeng September 17, 2025 01:30
Copilot finished work on behalf of shenxianpeng September 17, 2025 01:30
@shenxianpeng shenxianpeng marked this pull request as ready for review September 17, 2025 03:28
@coderabbitai
Copy link

coderabbitai bot commented Sep 17, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

@shenxianpeng shenxianpeng merged commit e610bcd into main Sep 17, 2025
4 of 5 checks passed
@shenxianpeng shenxianpeng deleted the copilot/fix-35644039-92ba-43eb-81f0-91c1faf2514f branch September 17, 2025 03:29
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