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

6 Commits

Author SHA1 Message Date
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
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
d9e9fb53ad Complete comprehensive planning verification and fix gaps 
Issues Found & Fixed:
- ✅ Found 7 missing E1 tasks (E1.3-E1.9)
- ✅ Created issues #136-#142
- ✅ Added to project board
- ✅ Assigned Feature Group E1

Documentation Updates:
- Updated README.md (127 → 134 tasks)
- Updated GITHUB_BOARD_SETUP_COMPLETE.md (127 → 134 tasks)
- Added complete E1 task list (#136-#142)
- Created PLANNING_VERIFICATION.md (comprehensive report)

Verification Results:
✅ All 134 tasks in roadmap
✅ All 134 GitHub issues created (#9-#142)
✅ All 134 items on project board
✅ All 22 feature groups assigned
✅ All 6 custom fields configured
✅ All documentation consistent
✅ No gaps or holes found

System Status: 100% COMPLETE AND VERIFIED

Files Changed:
- README.md
- GITHUB_BOARD_SETUP_COMPLETE.md
+ PLANNING_VERIFICATION.md (new)

GitHub Issues: #9-#142 (134 total)
Project Board: https://github.com/users/yusufkaraaslan/projects/2
Feature Groups: 22 (A1-J1)
Categories: 10 (A-J)
 2025-10-20 23:51:47 +03:00
yusyus
f66718122a Add project planning and roadmap documentation 
**Planning Structure:**
- TODO.md - Sprint planning and current tasks
- ROADMAP.md - Long-term vision and milestones
- .github/ISSUE_TEMPLATE/ - Issue templates for features and MCP tools

**TODO.md:**
- 5 phases: Core (done), Enhancement, Advanced, Docs, Integrations
- Current sprint tasks clearly defined
- Progress tracking with checkboxes

**ROADMAP.md:**
- Vision and milestones
- v1.0 (done), v1.1 (in progress), v1.2-3.0 (planned)
- Feature ideas categorized by priority
- Metrics and goals
- Release schedule

**Issue Templates:**
- feature_request.md - General features
- mcp_tool.md - New MCP tools specifically

Next: Fix tests, test MCP with Claude Code, document setup

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

Co-Authored-By: Claude <noreply@anthropic.com>
 2025-10-19 15:23:58 +03:00