update documentation, add script and workflow

Author: SamMorrowDrums

.github/workflows/docs-check.yml

@@ -0,0 +1,47 @@
+name: Documentation Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  docs-check:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
+    - name: Build docs generator
+      run: go build -o github-mcp-server ./cmd/github-mcp-server
+
+    - name: Generate documentation
+      run: ./github-mcp-server generate-docs --readme-path README.md
+
+    - name: Check for documentation changes
+      run: |
+        if ! git diff --exit-code README.md; then
+          echo "❌ Documentation is out of date!"
+          echo ""
+          echo "The generated documentation differs from what's committed."
+          echo "Please run the following command to update the documentation:"
+          echo ""
+          echo "  go run ./cmd/github-mcp-server generate-docs"
+          echo ""
+          echo "Then commit the changes."
+          echo ""
+          echo "Changes detected:"
+          git diff README.md
+          exit 1
+        else
+          echo "✅ Documentation is up to date!"
+        fi

CONTRIBUTING_SUMMARY.md

@@ -0,0 +1,85 @@
+# GitHub MCP Server - Contributing Summary
+
+This document summarizes the contribution guidelines for the GitHub MCP Server project.
+
+## Overview
+
+The GitHub MCP Server welcomes contributions from the community. All contributions are released under the project's open source license, and contributors must agree to abide by the Contributor Code of Conduct.
+
+## Prerequisites
+
+Before contributing, you need to install:
+- **Go** - Programming language for the project
+- **golangci-lint v2** - Linting tool for code quality
+
+## Contribution Process
+
+```mermaid
+flowchart TD
+    A[Start Contributing] --> B[Install Prerequisites]
+    B --> C[Fork & Clone Repository]
+    C --> D[Run Tests Locally]
+    D --> E{Tests Pass?}
+    E -->|No| F[Fix Issues]
+    F --> D
+    E -->|Yes| G[Run Linter]
+    G --> H{Linter Pass?}
+    H -->|No| I[Fix Linting Issues]
+    I --> G
+    H -->|Yes| J[Create New Branch]
+    J --> K[Make Changes]
+    K --> L[Add Tests]
+    L --> M[Run Tests & Linter Again]
+    M --> N{All Checks Pass?}
+    N -->|No| O[Fix Issues]
+    O --> M
+    N -->|Yes| P[Push to Fork]
+    P --> Q[Submit Pull Request]
+    Q --> R[Wait for Review]
+    R --> S[Celebrate! 🎉]
+```
+
+## Key Commands
+
+| Task | Command |
+|------|---------|
+| Run tests | `go test -v ./...` |
+| Run linter | `golangci-lint run` |
+| Create branch | `git checkout -b my-branch-name` |
+
+## Best Practices for PR Acceptance
+
+1. **Follow the style guide** - Adhere to the project's coding standards defined in `.golangci.yml`
+2. **Write tests** - Include comprehensive tests for your changes
+3. **Keep changes focused** - Submit separate PRs for unrelated changes
+4. **Write good commit messages** - Follow best practices for commit message formatting
+
+## Important Files
+
+- `CODE_OF_CONDUCT.md` - Code of conduct for contributors
+- `LICENSE` - Project license terms
+- `.golangci.yml` - Linting configuration and style guide
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)
+
+## Quick Start Checklist
+
+- [ ] Install Go
+- [ ] Install golangci-lint v2
+- [ ] Fork the repository
+- [ ] Clone your fork
+- [ ] Run `go test -v ./...` to verify setup
+- [ ] Run `golangci-lint run` to verify linting setup
+- [ ] Create a feature branch
+- [ ] Make your changes
+- [ ] Add tests
+- [ ] Verify tests and linting pass
+- [ ] Submit pull request
+
+---
+
+*This summary is based on the CONTRIBUTING.md file from the github/github-mcp-server repository.*