From edd1d99d705557c6ff2e9275f08ce636c5dd135b Mon Sep 17 00:00:00 2001 From: yusyus Date: Sun, 18 Jan 2026 01:18:26 +0300 Subject: [PATCH] docs: Update remaining files with v2.7.0 version and test counts - CONTRIBUTING.md: Added Ruff code quality tools section - MCP_SETUP.md: Updated to v2.7.0, 18 tools, 700+ tests - CLAUDE_INTEGRATION.md: Updated test count to 1200+ Co-Authored-By: Claude Sonnet 4.5 --- CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++ docs/guides/MCP_SETUP.md | 14 +++---- docs/reference/CLAUDE_INTEGRATION.md | 2 +- 3 files changed, 64 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f7e07a..306f47f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -324,6 +324,62 @@ def scrape_page(url: str, selectors: dict) -> dict: pass ``` +### Code Quality Tools + +We use **Ruff** for linting and code formatting. Ruff is a fast Python linter that combines multiple tools (Flake8, isort, Black, etc.) into one. + +**Running Ruff:** + +```bash +# Check for linting errors +uvx ruff check src/ tests/ + +# Auto-fix issues +uvx ruff check --fix src/ tests/ + +# Format code +uvx ruff format src/ tests/ +``` + +**Common Ruff Rules:** +- **SIM102** - Simplify nested if statements (use `and` instead) +- **SIM117** - Combine multiple `with` statements +- **B904** - Use `from e` for proper exception chaining +- **SIM113** - Use enumerate instead of manual counters +- **B007** - Use `_` for unused loop variables +- **ARG002** - Remove unused function arguments + +**CI/CD Integration:** + +All pull requests automatically run: +1. `ruff check` - Linting validation +2. `ruff format --check` - Format validation +3. `pytest` - Test suite + +Make sure all checks pass before submitting your PR: + +```bash +# Run the same checks as CI +uvx ruff check src/ tests/ +uvx ruff format --check src/ tests/ +pytest tests/ -v +``` + +**Pre-commit Setup (Optional):** + +You can set up pre-commit hooks to automatically run Ruff before each commit: + +```bash +# Install pre-commit +pip install pre-commit + +# Set up hooks (if .pre-commit-config.yaml exists) +pre-commit install + +# Run manually +pre-commit run --all-files +``` + --- ## Testing diff --git a/docs/guides/MCP_SETUP.md b/docs/guides/MCP_SETUP.md index 4e6e64e..5e918b0 100644 --- a/docs/guides/MCP_SETUP.md +++ b/docs/guides/MCP_SETUP.md @@ -1,15 +1,15 @@ -# Complete MCP Setup Guide - MCP 2025 (v2.4.0) +# Complete MCP Setup Guide - MCP 2025 (v2.7.0) Step-by-step guide to set up the Skill Seeker MCP server with 5 supported AI coding agents. -**Version 2.4.0 Highlights:** +**Version 2.7.0 Highlights:** - ✅ **MCP SDK v1.25.0** - Latest protocol support (upgraded from v1.18.0) - ✅ **FastMCP Framework** - Modern, decorator-based server implementation - ✅ **Dual Transport** - HTTP + stdio support (choose based on agent) -- ✅ **17 MCP Tools** - Expanded from 9 tools (8 new source management tools) +- ✅ **18 MCP Tools** - Expanded from 9 tools (enhance_skill + source management tools) - ✅ **Multi-Agent Support** - Claude Code, Cursor, Windsurf, VS Code + Cline, IntelliJ IDEA - ✅ **Auto-Configuration** - One-line setup with `./setup_mcp.sh` -- ✅ **Production Ready** - 34 comprehensive tests, 100% pass rate +- ✅ **Production Ready** - 700+ comprehensive tests, 100% pass rate --- @@ -51,7 +51,7 @@ Step-by-step guide to set up the Skill Seeker MCP server with 5 supported AI cod ### New Features -**17 MCP Tools** (expanded from 9): +**18 MCP Tools** (expanded from 9): **Config Tools (3):** - `generate_config` - Generate config for any documentation site @@ -168,7 +168,7 @@ In any connected agent: List all available MCP tools ``` -You should see 17 tools (up from 9 in v2.3.0). +You should see 18 tools (up from 9 in v2.3.0). ### 5. Optional: Run Auto-Configuration @@ -1390,7 +1390,7 @@ SETUP: 3. Restart agent VERIFY: -- "List all available MCP tools" (should show 17 tools) +- "List all available MCP tools" (should show 18 tools) - "List all available configs" (should show 24 configs) GENERATE SKILL: diff --git a/docs/reference/CLAUDE_INTEGRATION.md b/docs/reference/CLAUDE_INTEGRATION.md index f683eb7..0360a12 100644 --- a/docs/reference/CLAUDE_INTEGRATION.md +++ b/docs/reference/CLAUDE_INTEGRATION.md @@ -27,7 +27,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co - **🏗️ Platform Adaptors**: Clean architecture with platform-specific implementations - **✨ 18 MCP Tools**: Enhanced with multi-platform support (package, upload, enhance) - **📚 Comprehensive Documentation**: Complete guides for all platforms -- **🧪 Test Coverage**: 700+ tests passing, extensive platform compatibility testing +- **🧪 Test Coverage**: 1200+ tests passing, extensive platform compatibility testing **🚀 NEW: Three-Stream GitHub Architecture (v2.6.0)** - **📊 Three-Stream Fetcher**: Split GitHub repos into Code, Docs, and Insights streams