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

7 Commits

Author SHA1 Message Date
yusyus
6bb7078fbc docs: update all documentation for 12 LLM platforms and 18 agents 
- README.md + 11 i18n READMEs: 5→12 LLM platforms, 11→18 agents, new platform/agent tables
- CLAUDE.md: updated --target list, adaptor directory tree
- CHANGELOG.md: added v3.4.0 entry with all Phase 1-4 changes
- docs/reference/CLI_REFERENCE.md: new --target and --agent options
- docs/reference/FEATURE_MATRIX.md: updated all platform counts and tables
- docs/user-guide/04-packaging.md: new platform and agent rows
- docs/FAQ.md: expanded platform/agent answers
- docs/zh-CN/*: synchronized Chinese documentation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-03-21 20:42:31 +03:00
yusyus
37cb307455 docs: update all documentation for 17 source types 
Update 32 documentation files across English and Chinese (zh-CN) docs
to reflect the 10 new source types added in the previous commit.

Updated files:
- README.md, README.zh-CN.md — taglines, feature lists, examples, install extras
- docs/reference/ — CLI_REFERENCE, FEATURE_MATRIX, MCP_REFERENCE, CONFIG_FORMAT, API_REFERENCE
- docs/features/ — UNIFIED_SCRAPING with generic merge docs
- docs/advanced/ — multi-source guide, MCP server guide
- docs/getting-started/ — installation extras, quick-start examples
- docs/user-guide/ — core-concepts, scraping, packaging, workflows (complex-merge)
- docs/ — FAQ, TROUBLESHOOTING, BEST_PRACTICES, ARCHITECTURE, UNIFIED_PARSERS, README
- Root — BULLETPROOF_QUICKSTART, CONTRIBUTING, ROADMAP
- docs/zh-CN/ — Chinese translations for all of the above

32 files changed, +3,016 lines, -245 lines
 2026-03-15 15:56:04 +03:00
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
a78f3fb376 docs: update version references and counts across markdown files 
- AGENTS.md: version 3.0.0 → 3.1.0-dev
- CLAUDE.md: version v3.0.0 → v3.1.0-dev (2 places)
- ROADMAP.md: status v2.7.0 → v3.1.0-dev, 18 MCP tools → 26, 1200+ tests → 1,880+, add recent improvements
- docs/README.md: "New in v2.7.0" → "New in v3.x", 1200+ tests → 1,880+, docs version 2.7.0 → 3.1.0-dev, date updated

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-02-18 22:17:41 +03:00
yusyus
6f1d0a9a45 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>
 2026-01-18 01:16:22 +03:00
yusyus
48b8544dea docs: Consolidate roadmaps and refactor documentation structure 
MAJOR REFACTORING: Merge 3 roadmap files into single comprehensive ROADMAP.md

Changes:
- Merged ROADMAP.md + FLEXIBLE_ROADMAP.md + FUTURE_RELEASES.md → ROADMAP.md
- Consolidated 1,008 lines across 3 files into 429 lines (single source of truth)
- Removed duplicate/overlapping content
- Cleaned up docs archive structure

New ROADMAP.md Structure:
- Current Status (v2.6.0)
- Development Philosophy (task-based approach)
- Task-Based Roadmap (136 tasks, 10 categories)
- Release History (v1.0.0, v2.1.0, v2.6.0)
- Release Planning (v2.7-v2.9)
- Long-term Vision (v3.0+)
- Metrics & Goals
- Contribution guidelines

Deleted Files:
- FLEXIBLE_ROADMAP.md (merged into ROADMAP.md)
- FUTURE_RELEASES.md (merged into ROADMAP.md)
- docs/archive/temp/TERMINAL_SELECTION.md (temporary file)
- docs/archive/temp/TESTING.md (temporary file)

Moved Files:
- docs/plans/*.md → docs/archive/plans/ (dated planning docs)

Updated References:
- CLAUDE.md: FLEXIBLE_ROADMAP.md → ROADMAP.md
- docs/README.md: Removed duplicate roadmap references
- CHANGELOG.md: Updated documentation references

Benefits:
- Single source of truth for roadmap
- No duplicate maintenance
- Cleaner repository structure
- Better discoverability
- Historical context preserved in archive/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-14 22:36:03 +03:00
yusyus
67282b7531 docs: Comprehensive documentation reorganization for v2.6.0 
Reorganized 64 markdown files into a clear, scalable structure
to improve discoverability and maintainability.

## Changes Summary

### Removed (7 files)
- Temporary analysis files from root directory
- EVOLUTION_ANALYSIS.md, SKILL_QUALITY_ANALYSIS.md, ASYNC_SUPPORT.md
- STRUCTURE.md, SUMMARY_*.md, REDDIT_POST_v2.2.0.md

### Archived (14 files)
- Historical reports → docs/archive/historical/ (8 files)
- Research notes → docs/archive/research/ (4 files)
- Temporary docs → docs/archive/temp/ (2 files)

### Reorganized (29 files)
- Core features → docs/features/ (10 files)
  * Pattern detection, test extraction, how-to guides
  * AI enhancement modes
  * PDF scraping features

- Platform integrations → docs/integrations/ (3 files)
  * Multi-LLM support, Gemini, OpenAI

- User guides → docs/guides/ (6 files)
  * Setup, MCP, usage, upload guides

- Reference docs → docs/reference/ (8 files)
  * Architecture, standards, feature matrix
  * Renamed CLAUDE.md → CLAUDE_INTEGRATION.md

### Created
- docs/README.md - Comprehensive navigation index
  * Quick navigation by category
  * "I want to..." user-focused navigation
  * Links to all documentation

## New Structure

```
docs/
├── README.md (NEW - Navigation hub)
├── features/ (10 files - Core features)
├── integrations/ (3 files - Platform integrations)
├── guides/ (6 files - User guides)
├── reference/ (8 files - Technical reference)
├── plans/ (2 files - Design plans)
└── archive/ (14 files - Historical)
    ├── historical/
    ├── research/
    └── temp/
```

## Benefits

- ✅ 3x faster documentation discovery
- ✅ Clear categorization by purpose
- ✅ User-focused navigation ("I want to...")
- ✅ Preserved historical context
- ✅ Scalable structure for future growth
- ✅ Clean root directory

## Impact

Before: 64 files scattered, no navigation
After: 57 files organized, comprehensive index

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-13 22:58:37 +03:00