firefrost-gaming/skill-seekers-reference
3
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
669 Commits 1 Branch 0 Tags
d76ab1d9a41885c90558c2f527b38d6567f37c5f
Commit Graph

6 Commits

Author SHA1 Message Date
yusyus
ba9a8ff8b5 docs: complete documentation overhaul with v3.1.0 release notes and zh-CN translations 
Documentation restructure:
- New docs/getting-started/ guide (4 files: install, quick-start, first-skill, next-steps)
- New docs/user-guide/ section (6 files: core concepts through troubleshooting)
- New docs/reference/ section (CLI_REFERENCE, CONFIG_FORMAT, ENVIRONMENT_VARIABLES, MCP_REFERENCE)
- New docs/advanced/ section (custom-workflows, mcp-server, multi-source)
- New docs/ARCHITECTURE.md - system architecture overview
- Archived legacy files (QUICKSTART.md, QUICK_REFERENCE.md, docs/guides/USAGE.md) to docs/archive/legacy/

Chinese (zh-CN) translations:
- Full zh-CN mirror of all user-facing docs (getting-started, user-guide, reference, advanced)
- GitHub Actions workflow for translation sync (.github/workflows/translate-docs.yml)
- Translation sync checker script (scripts/check_translation_sync.sh)
- Translation helper script (scripts/translate_doc.py)

Content updates:
- CHANGELOG.md: [Unreleased] → [3.1.0] - 2026-02-22
- README.md: updated with new doc structure links
- AGENTS.md: updated agent documentation
- docs/features/UNIFIED_SCRAPING.md: updated for unified scraper workflow JSON config

Analysis/planning artifacts (kept for reference):
- DOCUMENTATION_OVERHAUL_PLAN.md, DOCUMENTATION_OVERHAUL_SUMMARY.md
- FEATURE_GAP_ANALYSIS.md, IMPLEMENTATION_GAPS_ANALYSIS.md, CREATE_COMMAND_COVERAGE_ANALYSIS.md
- CHINESE_TRANSLATION_IMPLEMENTATION_SUMMARY.md, ISSUE_260_UPDATE.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-02-22 01:01:51 +03:00
yusyus
6f9584ba67 feat: Add integration testing with real vector databases (Phase 5) 
Phase 5 of optional enhancements: Integration Testing

**New Files:**
- tests/docker-compose.test.yml (Docker Compose configuration)
  - Weaviate service (port 8080) with health checks
  - Qdrant service (ports 6333, 6334) with persistent storage
  - ChromaDB service (port 8000) with persistent storage
  - Auto-restart and health monitoring for all services
  - Named volumes for data persistence

- tests/test_integration_adaptors.py (695 lines)
  - 6 comprehensive integration tests with pytest
  - 3 test classes: TestWeaviateIntegration, TestChromaIntegration, TestQdrantIntegration
  - Complete workflows: package → upload → query → verify → cleanup
  - Metadata preservation tests
  - Query filtering tests (ChromaDB, Qdrant)
  - Graceful skipping when services unavailable
  - Best-effort cleanup in all tests

- scripts/run_integration_tests.sh (executable runner)
  - Beautiful terminal UI with colored output
  - Automated service lifecycle management
  - Health check verification for all services
  - Automatic client library installation
  - Commands: start, stop, test, run, logs, status, help
  - Complete workflow: start → test → stop

**Test Results:**
- All 6 integration tests skip gracefully when services not running
- All 164 adaptor tests still passing
- No regressions detected

**Usage:**
# Complete workflow (start services, run tests, cleanup)
./scripts/run_integration_tests.sh

# Or manage manually
docker-compose -f tests/docker-compose.test.yml up -d
pytest tests/test_integration_adaptors.py -v -m integration
docker-compose -f tests/docker-compose.test.yml down -v

# Individual commands
./scripts/run_integration_tests.sh start   # Start services only
./scripts/run_integration_tests.sh test    # Run tests only
./scripts/run_integration_tests.sh stop    # Stop services
./scripts/run_integration_tests.sh logs    # View service logs
./scripts/run_integration_tests.sh status  # Check service status

**Test Coverage:**
✓ Weaviate: Complete workflow + metadata preservation (2 tests)
✓ ChromaDB: Complete workflow + query filtering (2 tests)
✓ Qdrant: Complete workflow + payload filtering (2 tests)

**Key Features:**
• Real database integration (not mocks)
• Complete end-to-end workflows
• Metadata validation across all platforms
• Query filtering demonstrations
• Automatic cleanup (best-effort)
• Graceful degradation (skip if services unavailable)
• Health checks ensure service readiness
• Persistent storage with Docker volumes

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-02-07 22:55:02 +03:00
yusyus
b7e800614a feat: Add comprehensive performance benchmarking (Phase 4) 
Phase 4 of optional enhancements: Performance Benchmarking

**New Files:**
- tests/test_adaptor_benchmarks.py (478 lines)
  - 6 comprehensive benchmark tests with pytest
  - Measures format_skill_md() across 11 adaptors
  - Tests package operations (time + file size)
  - Analyzes scaling behavior (1-50 references)
  - Compares JSON vs ZIP compression ratios (~80-90x)
  - Quantifies metadata processing overhead (<10%)
  - Compares empty vs full skill performance

- scripts/run_benchmarks.sh (executable runner)
  - Beautiful terminal UI with colored output
  - Automated benchmark execution
  - Summary reporting with key insights
  - Package installation check

**Modified Files:**
- pyproject.toml
  - Added "benchmark" pytest marker

**Test Results:**
- All 6 benchmark tests passing
- All 164 adaptor tests still passing
- No regressions detected

**Key Findings:**
• All adaptors complete formatting in < 500ms
• Package operations complete in < 1 second
• Linear scaling confirmed (0.39x factor at 50 refs)
• Metadata overhead negligible (-1.8%)
• ZIP compression ratio: 83-84x
• Empty skill processing: 0.03ms
• Full skill (50 refs): 2.62ms

**Usage:**
./scripts/run_benchmarks.sh

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-02-07 22:51:06 +03:00
yusyus
5a78522dbc docs: Update all documentation to use new 'analyze' command 
- Update Chinese README (README.zh-CN.md) with new preset flags
- Update docs/features/*.md (PATTERN_DETECTION, HOW_TO_GUIDES, BOOTSTRAP_SKILL_TECHNICAL)
- Update scripts/bootstrap_skill.sh to use 'skill-seekers analyze'
- Update scripts/skill_header.md command examples
- Update tests/test_bootstrap_skill.py assertions
- Fix CHANGELOG.md historical entry with correct command name

All references to 'skill-seekers-codebase' updated to 'skill-seekers analyze'
except where needed for backward compatibility (pyproject.toml, E2E tests).

Related to Phase 1 implementation from previous commits.
 2026-01-29 22:56:33 +03:00
yusyus
38e8969ae7 feat: Merge PR #249 - Bootstrap skill with fixes and MCP optionality 
Merged PR #249 from @MiaoDX with enhancements:

Bootstrap Feature:
- Self-bootstrap: Generate skill-seekers as Claude Code skill
- Robust frontmatter detection (dynamic line finding)
- SKILL.md validation (YAML + Markdown structure)
- Comprehensive error handling (uv check, permission checks)
- 6 E2E tests with venv isolation

MCP Optionality (User Feature):
- MCP removed from core dependencies
- Optional install: pip install skill-seekers[mcp]
- Lazy loading with helpful error messages
- Interactive setup wizard on first run
- Backward compatible

Bug Fixes:
- Fixed codebase_scraper.py AttributeError (line 1193)
- Fixed test_bootstrap_skill_e2e.py Path vs str issue
- Updated test version expectations to 2.7.0
- Added httpx to core (required for async scraping)
- Added anthropic to core (required for AI enhancement)

Testing:
- 6 new bootstrap E2E tests (all passing)
- 1207/1217 tests passing (99.2% pass rate)
- All bootstrap and enhancement tests pass
- Remaining failures are pre-existing test infrastructure issues

Documentation:
- Updated CHANGELOG.md with v2.7.0 notes
- Updated README.md with bootstrap and installation options
- Added setup wizard guide

Files Modified (9):
- CHANGELOG.md, README.md - Documentation updates
- pyproject.toml - MCP optional, httpx/anthropic core, markers, entry points
- scripts/bootstrap_skill.sh - Dynamic frontmatter, validation, error handling
- src/skill_seekers/cli/install_skill.py - Lazy MCP loading
- tests/test_cli_paths.py - Version 2.7.0
- uv.lock - Dependency updates

New Files (2):
- src/skill_seekers/cli/setup_wizard.py - Interactive installation guide (95 lines)
- tests/test_bootstrap_skill_e2e.py - E2E bootstrap tests (169 lines)

Credits: @MiaoDX for PR #249

Co-Authored-By: MiaoDX <MiaoDX@hotmail.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-17 20:37:30 +03:00
MiaoDX
cc21239626 feat: Add bootstrap script to generate skill-seekers operational skill 
Add:
- scripts/bootstrap_skill.sh - Main script (uv sync, analyze)
- scripts/skill_header.md - Operational instructions header
- tests/test_bootstrap_skill.py - Pytest tests

The header contains manual instructions that can't be auto-extracted:
- Prerequisites (pip install)
- Command reference table
- Quick start examples

The script prepends this header to the auto-generated SKILL.md
which contains patterns, examples, and API docs from code analysis.

Usage:
  ./scripts/bootstrap_skill.sh
  cp -r output/skill-seekers ~/.claude/skills/

Output: output/skill-seekers/ (directory with SKILL.md)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
 2026-01-17 18:57:53 +08:00