docs: Comprehensive markdown documentation update for v2.7.0
Documentation Overhaul (7 new files, ~4,750 lines) Version Consistency Updates: - Updated all version references to v2.7.0 (ROADMAP.md) - Standardized test counts to 1200+ tests (README.md, Quality Assurance) - Updated MCP tool references to 18 tools (CHANGELOG.md) New Documentation Files: 1. docs/reference/API_REFERENCE.md (750 lines) - Complete programmatic usage guide for Python integration - All 8 core APIs documented with examples - Configuration schema reference and error handling - CI/CD integration examples (GitHub Actions, GitLab CI) - Performance optimization and batch processing 2. docs/features/BOOTSTRAP_SKILL.md (450 lines) - Self-hosting capability documentation (dogfooding) - Architecture and workflow explanation (3 components) - Troubleshooting and testing guide - CI/CD integration examples - Advanced usage and customization 3. docs/reference/CODE_QUALITY.md (550 lines) - Comprehensive Ruff linting documentation - All 21 v2.7.0 fixes explained with examples - Testing requirements and coverage standards - CI/CD integration (GitHub Actions, pre-commit hooks) - Security scanning with Bandit - Development workflow best practices 4. docs/guides/TESTING_GUIDE.md (750 lines) - Complete testing reference (1200+ tests) - Unit, integration, E2E, and MCP testing guides - Coverage analysis and improvement strategies - Debugging tests and troubleshooting - CI/CD matrix testing (2 OS, 4 Python versions) - Best practices and common patterns 5. docs/QUICK_REFERENCE.md (300 lines) - One-page cheat sheet for quick lookup - All CLI commands with examples - Common workflows and shortcuts - Environment variables and configurations - Tips & tricks for power users 6. docs/guides/MIGRATION_GUIDE.md (400 lines) - Version upgrade guides (v1.0.0 → v2.7.0) - Breaking changes and migration steps - Compatibility tables for all versions - Rollback instructions - Common migration issues and solutions 7. docs/FAQ.md (550 lines) - Comprehensive Q&A covering all major topics - Installation, usage, platforms, features - Troubleshooting shortcuts - Platform-specific questions - Advanced usage and programmatic integration Navigation Improvements: - Added "New in v2.7.0" section to docs/README.md - Integrated all new docs into navigation structure - Enhanced "Finding What You Need" section with new entries - Updated developer quick links (testing, code quality, API) - Cross-referenced related documentation Documentation Quality: - All version references consistent (v2.7.0) - Test counts standardized (1200+ tests) - MCP tool counts accurate (18 tools) - All internal links validated - Format consistency maintained - Proper heading hierarchy Impact: - 64 markdown files reviewed and validated - 7 new documentation files created (~4,750 lines) - 4 files updated (ROADMAP, README, CHANGELOG, docs/README) - Comprehensive coverage of all v2.7.0 features - Enhanced developer onboarding experience - Improved user documentation accessibility Related Issues: - Addresses documentation gaps identified in v2.7.0 planning - Supports code quality improvements (21 ruff fixes) - Documents bootstrap skill feature - Provides migration path for users upgrading from older versions Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
13
ROADMAP.md
13
ROADMAP.md
@@ -4,9 +4,9 @@ Transform Skill Seekers into the easiest way to create Claude AI skills from **a
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Current Status: v2.6.0 ✅
|
||||
## 🎯 Current Status: v2.7.0 ✅
|
||||
|
||||
**Latest Release:** v2.6.0 (January 14, 2026)
|
||||
**Latest Release:** v2.7.0 (January 18, 2026)
|
||||
|
||||
**What Works:**
|
||||
- ✅ Documentation scraping (HTML websites with llms.txt support)
|
||||
@@ -19,7 +19,14 @@ Transform Skill Seekers into the easiest way to create Claude AI skills from **a
|
||||
- ✅ 24 preset configs (including 7 unified configs)
|
||||
- ✅ Large docs support (40K+ pages with router skills)
|
||||
- ✅ C3.x codebase analysis suite (C3.1-C3.8)
|
||||
- ✅ 700+ tests passing
|
||||
- ✅ Bootstrap skill feature - self-hosting capability
|
||||
- ✅ 1200+ tests passing (improved from 700+)
|
||||
|
||||
**Recent Improvements (v2.7.0):**
|
||||
- ✅ **Code Quality**: Fixed all 21 ruff linting errors across codebase
|
||||
- ✅ **Version Sync**: Synchronized version numbers across all package files
|
||||
- ✅ **Bug Fixes**: Resolved case-sensitivity and test fixture issues
|
||||
- ✅ **Documentation**: Comprehensive documentation updates and new guides
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user