Initial commit: workflow-kit documentation

- Complete PR Auto-Labeler documentation
- MkDocs Material theme with developer-focused design
- GitHub Actions workflow for automatic deployment
- 30+ rule documentation with examples
- Quick start, configuration, and troubleshooting guides
- Custom CSS for dark theme and code styling

Author: ddjain

.github/workflows/deploy-docs.yml

@@ -0,0 +1,42 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.txt
+      
+      - name: Build MkDocs site
+        run: mkdocs build --strict
+      
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.gitignore

@@ -0,0 +1,38 @@
+# MkDocs build output
+site/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info/
+dist/
+build/
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Node modules (if any)
+node_modules/
+
+# Coverage
+.coverage
+htmlcov/
+coverage/
+

Dockerfile

@@ -0,0 +1,29 @@
+############################################
+# Builder stage: install deps and build site
+############################################
+FROM python:3.11-slim AS builder
+
+WORKDIR /site
+
+# Install build dependencies
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy source and build static site
+COPY . .
+RUN mkdocs build --strict
+
+############################################
+# Runtime stage: serve static site via Nginx
+############################################
+FROM nginx:alpine AS runtime
+
+# Copy built site to Nginx html directory
+COPY --from=builder /site/site /usr/share/nginx/html
+
+EXPOSE 80
+
+# Optional: healthcheck (Nginx default index)
+HEALTHCHECK CMD wget -qO- http://localhost/ >/dev/null 2>&1 || exit 1
+
+# Start Nginx (default CMD provided by base image)

README.md

@@ -0,0 +1,85 @@
+# workflow-kit Documentation
+
+> Comprehensive documentation for workflow-kit GitHub Actions workflows
+
+[![Deploy Docs](https://github.com/workflow-kit/docs/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/workflow-kit/docs/actions/workflows/deploy-docs.yml)
+
+## 📚 Documentation
+
+Visit the documentation site: **[workflow-kit.github.io/docs](https://workflow-kit.github.io/docs/)**
+
+## 🚀 Quick Start
+
+This documentation is built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
+
+### Local Development
+
+```bash
+# Install dependencies
+pip install -r requirements.txt
+
+# Serve locally
+mkdocs serve
+
+# Access at http://localhost:8000
+```
+
+### Build
+
+```bash
+# Build static site
+mkdocs build
+
+# Output in site/ directory
+```
+
+## 🛠️ Stack
+
+- **MkDocs** — Static site generator
+- **Material for MkDocs** — Theme
+- **Mermaid** — Diagrams
+- **GitHub Pages** — Hosting
+
+## 📂 Structure
+
+```
+docs/
+├── docs/                      # Documentation source
+│   ├── index.md              # Homepage
+│   ├── getting-started.md    # Getting started guide
+│   ├── workflows/            # Workflow documentation
+│   │   └── pr-auto-labeler/  # PR Auto-Labeler workflow
+│   └── assets/               # Images and static files
+├── mkdocs.yml                # MkDocs configuration
+├── requirements.txt          # Python dependencies
+├── Dockerfile               # Docker build
+└── .github/workflows/       # GitHub Actions
+    └── deploy-docs.yml      # Auto-deploy to GitHub Pages
+```
+
+## 🔄 Deployment
+
+Documentation is automatically deployed to GitHub Pages when changes are pushed to `main` branch.
+
+The deployment workflow:
+1. Installs dependencies
+2. Builds the MkDocs site
+3. Deploys to `gh-pages` branch
+4. GitHub Pages serves the site
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Test locally with `mkdocs serve`
+5. Submit a pull request
+
+## 📝 License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+**Made with ❤️ by the workflow-kit team**
+

docs/assets/images/logo.svg

@@ -0,0 +1,127 @@
+# Getting Started
+
+Welcome to **workflow-kit** — your collection of production-ready GitHub Actions workflows.
+
+---
+
+## What is workflow-kit?
+
+workflow-kit provides battle-tested, reusable GitHub Actions workflows that automate common development tasks. Each workflow is:
+
+- ⚡ **Easy to integrate** — Setup in minutes
+- 🔧 **Fully customizable** — Configure to your needs
+- 📚 **Well-documented** — Comprehensive guides
+- 🚀 **Production-ready** — Used by teams worldwide
+
+---
+
+## Available Workflows
+
+### 🏷️ PR Auto-Labeler
+
+Automatically label pull requests based on code changes, patterns, and metadata.
+
+**Quick Example:**
+
+```yaml title=".github/workflows/pr-labeler.yml"
+name: Auto Label PRs
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  label:
+    uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
+    with:
+      enabled_rules: '["ui-change", "test-missing", "large-pr"]'
+```
+
+[Get Started with PR Auto-Labeler →](workflows/pr-auto-labeler/quick-start.md){ .md-button .md-button--primary }
+
+---
+
+## Quick Start
+
+=== "Step 1: Choose a Workflow"
+
+    Browse available workflows and choose one that fits your needs.
+    
+    [:material-tag-multiple: PR Auto-Labeler](workflows/pr-auto-labeler/index.md)
+
+=== "Step 2: Add Workflow File"
+
+    Create `.github/workflows/` directory and add the workflow YAML file.
+    
+    ```bash
+    mkdir -p .github/workflows
+    # Copy workflow configuration
+    ```
+
+=== "Step 3: Configure"
+
+    Customize the workflow configuration to match your team's needs.
+    
+    - Enable specific rules
+    - Set custom labels
+    - Adjust thresholds
+
+=== "Step 4: Test"
+
+    Create a test PR and verify the workflow runs correctly.
+    
+    Check the Actions tab for execution logs.
+
+---
+
+## Why Use workflow-kit?
+
+<div class="grid cards" markdown>
+
+-   :material-clock-fast:{ .lg .middle } __Save Time__
+
+    ---
+
+    Automate repetitive tasks and focus on what matters — writing code and reviewing PRs.
+
+-   :material-shield-check:{ .lg .middle } __Improve Quality__
+
+    ---
+
+    Catch issues early with automated checks before they reach production.
+
+-   :material-chart-line:{ .lg .middle } __Better Visibility__
+
+    ---
+
+    Get instant insights into PR content with automated labeling and analysis.
+
+-   :material-account-group:{ .lg .middle } __Team Consistency__
+
+    ---
+
+    Standardize processes across repositories and ensure everyone follows best practices.
+
+</div>
+
+---
+
+## Next Steps
+
+1. [:rocket: Explore PR Auto-Labeler](workflows/pr-auto-labeler/index.md)
+2. [:books: Read the Documentation](workflows/pr-auto-labeler/quick-start.md)
+3. [:bulb: See Usage Examples](workflows/pr-auto-labeler/examples.md)
+4. [:material-github: Star on GitHub](https://github.com/workflow-kit)
+
+---
+
+## Support
+
+Need help? We're here for you:
+
+- [:material-book-open: Documentation](workflows/pr-auto-labeler/index.md)
+- [:material-chat: GitHub Discussions](https://github.com/workflow-kit/pr-auto-labeler/discussions)
+- [:material-bug: Report Issues](https://github.com/workflow-kit/pr-auto-labeler/issues)