Update documentation for unified multi-source scraping (v2.0.0)
Major documentation update explaining the new unified scraping system that combines documentation + GitHub + PDF sources in a single skill with automatic conflict detection.
## Changes:
**README.md:**
- Update version badge to v2.0.0
- Add "Unified Multi-Source Scraping" to Key Features section
- Add comprehensive Option 5 section showing:
- Problem statement (documentation drift)
- Solution with code example
- Conflict detection types and severity levels
- Transparent reporting with side-by-side comparison
- List of advantages (identifies gaps, catches changes, single source of truth)
- Available unified configs
- Link to full guide (docs/UNIFIED_SCRAPING.md)
**CLAUDE.md:**
- Update Current Status to v2.0.0
- Add "Major Release: Unified Multi-Source Scraping" in Recent Updates
- Update configs count from 11/11 to 15/15 (added 4 unified configs)
- Add new "Unified Multi-Source Scraping" section under Core Commands
- Include command examples and feature highlights
- Explain what makes unified scraping special
**QUICKSTART.md:**
- Add Option D: Unified Multi-Source to Step 2
- Add unified configs to Available Presets section
- Show react_unified, django_unified, fastapi_unified, godot_unified examples
## Value:
This documentation update explains how unified scraping helps developers:
- Mix documentation + code in one skill
- Automatically detect conflicts (missing_in_docs, missing_in_code, signature_mismatch)
- Get transparent side-by-side comparisons with ⚠️ warnings
- Identify documentation gaps and outdated docs
- Create a single source of truth combining both sources
Related to: Phase 7-11 unified scraper implementation (commit 5d8c7e3)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
43
CLAUDE.md
43
CLAUDE.md
@@ -2,13 +2,23 @@
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## 🎯 Current Status (October 21, 2025)
|
||||
## 🎯 Current Status (October 26, 2025)
|
||||
|
||||
**Version:** v1.0.0 (Production Ready)
|
||||
**Version:** v2.0.0 (Production Ready - Major Feature Release)
|
||||
**Active Development:** Flexible, incremental task-based approach
|
||||
|
||||
### Recent Updates (This Week):
|
||||
|
||||
**🚀 Major Release: Unified Multi-Source Scraping (v2.0.0)**
|
||||
- **NEW**: Combine documentation + GitHub + PDF in one skill
|
||||
- **NEW**: Automatic conflict detection between docs and code
|
||||
- **NEW**: Rule-based and AI-powered merging
|
||||
- **NEW**: Transparent conflict reporting with side-by-side comparison
|
||||
- **NEW**: 4 example unified configs (React, Django, FastAPI, Godot)
|
||||
- **NEW**: Complete documentation in docs/UNIFIED_SCRAPING.md
|
||||
- **NEW**: Integration tests (6/6 passing)
|
||||
- **Status**: ✅ Production ready and fully tested
|
||||
|
||||
**✅ Community Response (H1 Group):**
|
||||
- **Issue #8 Fixed** - Added BULLETPROOF_QUICKSTART.md and TROUBLESHOOTING.md for beginners
|
||||
- **Issue #7 Fixed** - Fixed all 11 configs (Django, Laravel, Astro, Tailwind) - 100% working
|
||||
@@ -17,8 +27,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
- **MCP Setup Fixed** - Path expansion bug resolved in setup_mcp.sh
|
||||
|
||||
**📦 Configs Status:**
|
||||
- ✅ **11/11 production configs verified working** (100% success rate)
|
||||
- ✅ New Laravel config added
|
||||
- ✅ **15/15 production configs verified working** (100% success rate)
|
||||
- ✅ 4 new unified configs added (React, Django, FastAPI, Godot)
|
||||
- ✅ All selectors tested and validated
|
||||
|
||||
**📋 Next Up:**
|
||||
@@ -95,7 +105,7 @@ export ANTHROPIC_API_KEY=sk-ant-...
|
||||
### Quick Start - Use a Preset
|
||||
|
||||
```bash
|
||||
# Scrape and build with a preset configuration
|
||||
# Single-source scraping (documentation only)
|
||||
python3 cli/doc_scraper.py --config configs/godot.json
|
||||
python3 cli/doc_scraper.py --config configs/react.json
|
||||
python3 cli/doc_scraper.py --config configs/vue.json
|
||||
@@ -104,6 +114,29 @@ python3 cli/doc_scraper.py --config configs/laravel.json
|
||||
python3 cli/doc_scraper.py --config configs/fastapi.json
|
||||
```
|
||||
|
||||
### Unified Multi-Source Scraping (**NEW - v2.0.0**)
|
||||
|
||||
```bash
|
||||
# Combine documentation + GitHub + PDF in one skill
|
||||
python3 cli/unified_scraper.py --config configs/react_unified.json
|
||||
python3 cli/unified_scraper.py --config configs/django_unified.json
|
||||
python3 cli/unified_scraper.py --config configs/fastapi_unified.json
|
||||
python3 cli/unified_scraper.py --config configs/godot_unified.json
|
||||
|
||||
# Override merge mode
|
||||
python3 cli/unified_scraper.py --config configs/react_unified.json --merge-mode claude-enhanced
|
||||
|
||||
# Result: One comprehensive skill with conflict detection
|
||||
```
|
||||
|
||||
**What makes it special:**
|
||||
- ✅ Detects discrepancies between documentation and code
|
||||
- ✅ Shows both versions side-by-side with ⚠️ warnings
|
||||
- ✅ Identifies outdated docs and undocumented features
|
||||
- ✅ Single source of truth showing intent (docs) AND reality (code)
|
||||
|
||||
**See full guide:** [docs/UNIFIED_SCRAPING.md](docs/UNIFIED_SCRAPING.md)
|
||||
|
||||
### First-Time User Workflow (Recommended)
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user