chore: remove stale planning, QA, and release markdown files
Deleted 46 files that were internal development artifacts: - PHASE*_COMPLETION_SUMMARY.md (5 files) - QA_*.md / COMPREHENSIVE_QA_REPORT.md (8 files) - RELEASE_PLAN*.md / RELEASE_*_SUMMARY.md / RELEASE_*_CHECKLIST.md (8 files) - CLI_REFACTOR_*.md (3 files) - V3_*.md (3 files) - ALL_PHASES_COMPLETION_SUMMARY.md, BUGFIX_SUMMARY.md, DEV_TO_POST.md, ENHANCEMENT_WORKFLOW_SYSTEM.md, FINAL_STATUS.md, KIMI_QA_FIXES_SUMMARY.md, TEST_RESULTS_SUMMARY.md, UI_INTEGRATION_GUIDE.md, UNIFIED_CREATE_IMPLEMENTATION_SUMMARY.md, WEBSITE_HANDOFF_V3.md, WORKFLOW_ENHANCEMENT_SEQUENTIAL_EXECUTION.md, CLI_OPTIONS_COMPLETE_LIST.md - docs/COMPREHENSIVE_QA_REPORT.md, docs/FINAL_QA_VERIFICATION.md, docs/QA_FIXES_*.md, docs/WEEK2_TESTING_GUIDE.md - .github/ISSUES_TO_CREATE.md, .github/PROJECT_BOARD_SETUP.md, .github/SETUP_GUIDE.md, .github/SETUP_INSTRUCTIONS.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
yusyus
258
.github/ISSUES_TO_CREATE.md
vendored
258
.github/ISSUES_TO_CREATE.md
vendored
@@ -1,258 +0,0 @@
|
||||
# GitHub Issues to Create
|
||||
|
||||
Copy these to GitHub Issues manually or use `gh issue create`
|
||||
|
||||
---
|
||||
|
||||
## Issue 1: Fix 3 Remaining Test Failures
|
||||
|
||||
**Title:** Fix 3 test failures (warnings vs errors handling)
|
||||
|
||||
**Labels:** bug, tests, good first issue
|
||||
|
||||
**Body:**
|
||||
```markdown
|
||||
## Problem
|
||||
3 tests are failing because they check for errors but the validation function returns warnings for these cases:
|
||||
|
||||
1. `test_missing_recommended_selectors` - Missing selectors are warnings, not errors
|
||||
2. `test_invalid_rate_limit_too_high` - Rate limit warnings
|
||||
3. `test_invalid_max_pages_too_high` - Max pages warnings
|
||||
|
||||
**Current:** 68/71 tests passing (95.8%)
|
||||
**Target:** 71/71 tests passing (100%)
|
||||
|
||||
## Location
|
||||
- `tests/test_config_validation.py`
|
||||
|
||||
## Solution
|
||||
Update tests to check warnings tuple instead of errors:
|
||||
```python
|
||||
# Before
|
||||
errors, _ = validate_config(config)
|
||||
self.assertTrue(any('title' in error.lower() for error in errors))
|
||||
|
||||
# After
|
||||
_, warnings = validate_config(config)
|
||||
self.assertTrue(any('title' in warning.lower() for warning in warnings))
|
||||
```
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] All 71 tests passing
|
||||
- [ ] Tests properly differentiate errors vs warnings
|
||||
- [ ] No false positives
|
||||
|
||||
## Files to Modify
|
||||
- `tests/test_config_validation.py` (3 test methods)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Issue 2: Create MCP Setup Guide
|
||||
|
||||
**Title:** Create comprehensive MCP setup guide for Claude Code
|
||||
|
||||
**Labels:** documentation, mcp, enhancement
|
||||
|
||||
**Body:**
|
||||
```markdown
|
||||
## Goal
|
||||
Create step-by-step guide for users to set up the MCP server with Claude Code.
|
||||
|
||||
## Content Needed
|
||||
|
||||
### 1. Prerequisites
|
||||
- Python 3.7+
|
||||
- Claude Code installed
|
||||
- Repository cloned
|
||||
|
||||
### 2. Installation Steps
|
||||
- Install dependencies
|
||||
- Configure MCP in Claude Code
|
||||
- Verify installation
|
||||
|
||||
### 3. Configuration Example
|
||||
- Complete `~/.config/claude-code/mcp.json` example
|
||||
- Path configuration
|
||||
- Troubleshooting common issues
|
||||
|
||||
### 4. Usage Examples
|
||||
- Generate config for new site
|
||||
- Estimate pages
|
||||
- Scrape and build skill
|
||||
- End-to-end workflow
|
||||
|
||||
### 5. Screenshots/Video
|
||||
- Visual guide through setup
|
||||
- Example interactions
|
||||
|
||||
## Deliverables
|
||||
- [ ] `docs/MCP_SETUP.md` - Main setup guide
|
||||
- [ ] `.claude/mcp_config.example.json` - Example config
|
||||
- [ ] Screenshots in `docs/images/`
|
||||
- [ ] Optional: Quick start video
|
||||
|
||||
## Target Audience
|
||||
Users who have Claude Code but never used MCP before.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Issue 3: Test MCP Server Functionality
|
||||
|
||||
**Title:** Test MCP server with actual Claude Code instance
|
||||
|
||||
**Labels:** testing, mcp, priority-high
|
||||
|
||||
**Body:**
|
||||
```markdown
|
||||
## Goal
|
||||
Verify MCP server works correctly with actual Claude Code.
|
||||
|
||||
## Test Plan
|
||||
|
||||
### Setup
|
||||
1. Install MCP server locally
|
||||
2. Configure Claude Code MCP settings
|
||||
3. Restart Claude Code
|
||||
|
||||
### Tests
|
||||
|
||||
#### Test 1: List Configs
|
||||
```
|
||||
User: "List all available configs"
|
||||
Expected: Shows 7 configs (godot, react, vue, django, fastapi, kubernetes, steam-economy)
|
||||
```
|
||||
|
||||
#### Test 2: Generate Config
|
||||
```
|
||||
User: "Generate config for Tailwind CSS at https://tailwindcss.com/docs"
|
||||
Expected: Creates configs/tailwind.json
|
||||
```
|
||||
|
||||
#### Test 3: Estimate Pages
|
||||
```
|
||||
User: "Estimate pages for configs/tailwind.json"
|
||||
Expected: Returns estimation results
|
||||
```
|
||||
|
||||
#### Test 4: Validate Config
|
||||
```
|
||||
User: "Validate configs/react.json"
|
||||
Expected: Shows config is valid
|
||||
```
|
||||
|
||||
#### Test 5: Scrape Docs
|
||||
```
|
||||
User: "Scrape docs using configs/kubernetes.json with max 10 pages"
|
||||
Expected: Creates output/kubernetes/ directory with SKILL.md
|
||||
```
|
||||
|
||||
#### Test 6: Package Skill
|
||||
```
|
||||
User: "Package skill at output/kubernetes/"
|
||||
Expected: Creates kubernetes.zip
|
||||
```
|
||||
|
||||
## Success Criteria
|
||||
- [ ] All 6 tools respond correctly
|
||||
- [ ] No errors in Claude Code logs
|
||||
- [ ] Generated files are correct
|
||||
- [ ] Performance is acceptable (<5s for simple operations)
|
||||
|
||||
## Documentation
|
||||
Document any issues found and solutions in test results.
|
||||
|
||||
## Files
|
||||
- [ ] Create `tests/mcp_integration_test.md` with results
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Issue 4: Update Documentation for Monorepo
|
||||
|
||||
**Title:** Update all documentation for new monorepo structure
|
||||
|
||||
**Labels:** documentation, breaking-change
|
||||
|
||||
**Body:**
|
||||
```markdown
|
||||
## Goal
|
||||
Update all documentation to reflect cli/ and mcp/ structure.
|
||||
|
||||
## Files to Update
|
||||
|
||||
### 1. README.md
|
||||
- [ ] Update file structure diagram
|
||||
- [ ] Add MCP section
|
||||
- [ ] Update installation commands
|
||||
- [ ] Add quick start for both CLI and MCP
|
||||
|
||||
### 2. CLAUDE.md
|
||||
- [ ] Update paths (cli/doc_scraper.py)
|
||||
- [ ] Add MCP usage section
|
||||
- [ ] Update examples
|
||||
|
||||
### 3. docs/USAGE.md
|
||||
- [ ] Update all command paths
|
||||
- [ ] Add MCP usage section
|
||||
- [ ] Update examples
|
||||
|
||||
### 4. docs/TESTING.md
|
||||
- [ ] Update test run commands
|
||||
- [ ] Note new import structure
|
||||
|
||||
### 5. QUICKSTART.md
|
||||
- [ ] Update for both CLI and MCP
|
||||
- [ ] Add decision tree: "Use CLI or MCP?"
|
||||
|
||||
## New Documentation Needed
|
||||
- [ ] `mcp/QUICKSTART.md` - MCP-specific quick start
|
||||
- [ ] Update diagrams/architecture docs
|
||||
|
||||
## Breaking Changes to Document
|
||||
- CLI tools moved from root to `cli/`
|
||||
- Import path changes: `from doc_scraper` → `from cli.doc_scraper`
|
||||
- New MCP-based workflow available
|
||||
|
||||
## Validation
|
||||
- [ ] All code examples work
|
||||
- [ ] All paths are correct
|
||||
- [ ] Links are not broken
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## How to Create Issues
|
||||
|
||||
### Option 1: GitHub Web UI
|
||||
1. Go to https://github.com/yusufkaraaslan/Skill_Seekers/issues/new
|
||||
2. Copy title and body
|
||||
3. Add labels
|
||||
4. Create issue
|
||||
|
||||
### Option 2: GitHub CLI
|
||||
```bash
|
||||
# Issue 1
|
||||
gh issue create --title "Fix 3 test failures (warnings vs errors handling)" \
|
||||
--body-file issue1.md \
|
||||
--label "bug,tests,good first issue"
|
||||
|
||||
# Issue 2
|
||||
gh issue create --title "Create comprehensive MCP setup guide for Claude Code" \
|
||||
--body-file issue2.md \
|
||||
--label "documentation,mcp,enhancement"
|
||||
|
||||
# Issue 3
|
||||
gh issue create --title "Test MCP server with actual Claude Code instance" \
|
||||
--body-file issue3.md \
|
||||
--label "testing,mcp,priority-high"
|
||||
|
||||
# Issue 4
|
||||
gh issue create --title "Update all documentation for new monorepo structure" \
|
||||
--body-file issue4.md \
|
||||
--label "documentation,breaking-change"
|
||||
```
|
||||
|
||||
### Option 3: Manual Script
|
||||
Save each issue body to issue1.md, issue2.md, etc., then use gh CLI as shown above.
|
||||
542
.github/PROJECT_BOARD_SETUP.md
vendored
542
.github/PROJECT_BOARD_SETUP.md
vendored
@@ -1,542 +0,0 @@
|
||||
# GitHub Project Board Setup for Skill Seekers
|
||||
|
||||
## 🎯 Project Board Configuration
|
||||
|
||||
### Project Name: **Skill Seekers Development Roadmap**
|
||||
|
||||
### Board Type: **Table** with custom fields
|
||||
|
||||
---
|
||||
|
||||
## 📊 Project Columns/Status
|
||||
|
||||
1. **📋 Backlog** - Ideas and future features
|
||||
2. **🎯 Ready** - Prioritized and ready to start
|
||||
3. **🚀 In Progress** - Currently being worked on
|
||||
4. **👀 In Review** - Waiting for review/testing
|
||||
5. **✅ Done** - Completed tasks
|
||||
6. **🔄 Blocked** - Waiting on dependencies
|
||||
|
||||
---
|
||||
|
||||
## 🏷️ Labels to Create
|
||||
|
||||
### Priority Labels
|
||||
- `priority: critical` - 🔴 Red - Must be fixed immediately
|
||||
- `priority: high` - 🟠 Orange - Important feature/fix
|
||||
- `priority: medium` - 🟡 Yellow - Normal priority
|
||||
- `priority: low` - 🟢 Green - Nice to have
|
||||
|
||||
### Type Labels
|
||||
- `type: feature` - 🆕 New functionality
|
||||
- `type: bug` - 🐛 Something isn't working
|
||||
- `type: enhancement` - ✨ Improve existing feature
|
||||
- `type: documentation` - 📚 Documentation updates
|
||||
- `type: refactor` - ♻️ Code refactoring
|
||||
- `type: performance` - ⚡ Performance improvements
|
||||
- `type: security` - 🔒 Security-related
|
||||
|
||||
### Component Labels
|
||||
- `component: scraper` - Core scraping engine
|
||||
- `component: enhancement` - AI enhancement system
|
||||
- `component: mcp` - MCP server integration
|
||||
- `component: cli` - Command-line tools
|
||||
- `component: config` - Configuration system
|
||||
- `component: website` - Website/documentation
|
||||
- `component: tests` - Testing infrastructure
|
||||
|
||||
### Status Labels
|
||||
- `status: blocked` - Blocked by dependency
|
||||
- `status: needs-discussion` - Needs team discussion
|
||||
- `status: help-wanted` - Looking for contributors
|
||||
- `status: good-first-issue` - Good for new contributors
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Milestones
|
||||
|
||||
### Milestone 1: **v1.1.0 - Website Launch** (Due: 2 weeks)
|
||||
**Goal:** Launch skillseekersweb.com with documentation
|
||||
|
||||
**Issues:**
|
||||
- Website landing page design
|
||||
- Documentation migration
|
||||
- Preset showcase gallery
|
||||
- Blog setup
|
||||
- SEO optimization
|
||||
- Analytics integration
|
||||
|
||||
### Milestone 2: **v1.2.0 - Core Improvements** (Due: 1 month)
|
||||
**Goal:** Address technical debt and user feedback
|
||||
|
||||
**Issues:**
|
||||
- URL normalization/deduplication
|
||||
- Memory optimization for large docs
|
||||
- Parser fallback (lxml)
|
||||
- Selector validation tool
|
||||
- Incremental update system
|
||||
|
||||
### Milestone 3: **v2.0.0 - Advanced Features** (Due: 2 months)
|
||||
**Goal:** Major feature additions
|
||||
|
||||
**Issues:**
|
||||
- Parallel scraping with async
|
||||
- Image/diagram extraction
|
||||
- Export formats (PDF, EPUB)
|
||||
- Interactive config builder
|
||||
- Cloud deployment option
|
||||
- Team collaboration features
|
||||
|
||||
---
|
||||
|
||||
## 📝 Issues to Create
|
||||
|
||||
### 🌐 Website Development (Milestone: v1.1.0)
|
||||
|
||||
#### Issue #1: Create skillseekersweb.com Landing Page
|
||||
**Labels:** `type: feature`, `priority: high`, `component: website`
|
||||
**Description:**
|
||||
Design and implement professional landing page with:
|
||||
- Hero section with demo
|
||||
- Feature highlights
|
||||
- GitHub stats integration
|
||||
- CTA buttons (GitHub, Docs)
|
||||
- Responsive design
|
||||
|
||||
**Acceptance Criteria:**
|
||||
- [ ] Mobile responsive
|
||||
- [ ] Load time < 2s
|
||||
- [ ] SEO optimized
|
||||
- [ ] Analytics tracking
|
||||
- [ ] Contact form working
|
||||
|
||||
---
|
||||
|
||||
#### Issue #2: Migrate Documentation to Website
|
||||
**Labels:** `type: documentation`, `priority: high`, `component: website`
|
||||
**Description:**
|
||||
Convert existing markdown docs to website format:
|
||||
- Quick Start guide
|
||||
- Installation instructions
|
||||
- Configuration guide
|
||||
- MCP setup tutorial
|
||||
- API reference
|
||||
|
||||
**Files to migrate:**
|
||||
- README.md
|
||||
- QUICKSTART.md
|
||||
- docs/CLAUDE.md
|
||||
- docs/ENHANCEMENT.md
|
||||
- docs/UPLOAD_GUIDE.md
|
||||
- docs/MCP_SETUP.md
|
||||
|
||||
---
|
||||
|
||||
#### Issue #3: Create Preset Showcase Gallery
|
||||
**Labels:** `type: feature`, `priority: medium`, `component: website`
|
||||
**Description:**
|
||||
Interactive gallery showing all 8 preset configurations:
|
||||
- Visual cards for each preset
|
||||
- Download/copy config buttons
|
||||
- Live preview of generated skills
|
||||
- Search/filter functionality
|
||||
|
||||
**Presets to showcase:**
|
||||
- Godot, React, Vue, Django, FastAPI, Tailwind, Kubernetes, Astro
|
||||
|
||||
---
|
||||
|
||||
#### Issue #4: Set Up Blog with Release Notes
|
||||
**Labels:** `type: feature`, `priority: medium`, `component: website`
|
||||
**Description:**
|
||||
Create blog section for:
|
||||
- Release announcements
|
||||
- Tutorial articles
|
||||
- Technical deep-dives
|
||||
- Use case studies
|
||||
|
||||
**Platform options:**
|
||||
- Next.js + MDX
|
||||
- Ghost CMS
|
||||
- Hashnode integration
|
||||
|
||||
---
|
||||
|
||||
#### Issue #5: SEO Optimization
|
||||
**Labels:** `type: enhancement`, `priority: medium`, `component: website`
|
||||
**Description:**
|
||||
- Meta tags optimization
|
||||
- Open Graph images
|
||||
- Sitemap generation
|
||||
- robots.txt configuration
|
||||
- Schema.org markup
|
||||
- Performance optimization (Lighthouse 90+)
|
||||
|
||||
---
|
||||
|
||||
### 🔧 Core Improvements (Milestone: v1.2.0)
|
||||
|
||||
#### Issue #6: Implement URL Normalization
|
||||
**Labels:** `type: enhancement`, `priority: high`, `component: scraper`
|
||||
**Description:**
|
||||
Prevent duplicate scraping of same page with different query params.
|
||||
|
||||
**Current Issue:**
|
||||
- `/page?sort=asc` and `/page?sort=desc` treated as different pages
|
||||
- Wastes bandwidth and storage
|
||||
|
||||
**Solution:**
|
||||
- Strip query parameters (configurable)
|
||||
- Normalize fragments
|
||||
- Canonical URL detection
|
||||
|
||||
**Code Location:** `cli/doc_scraper.py:49-64` (is_valid_url)
|
||||
|
||||
---
|
||||
|
||||
#### Issue #7: Memory Optimization for Large Docs
|
||||
**Labels:** `type: performance`, `priority: high`, `component: scraper`
|
||||
**Description:**
|
||||
Current implementation loads all pages in memory (4GB+ for 40K pages).
|
||||
|
||||
**Improvements needed:**
|
||||
- Streaming/chunking for 10K+ pages
|
||||
- Disk-based intermediate storage
|
||||
- Generator-based processing
|
||||
- Memory profiling
|
||||
|
||||
**Code Location:** `cli/doc_scraper.py:228-251` (scrape_all)
|
||||
|
||||
---
|
||||
|
||||
#### Issue #8: Add HTML Parser Fallback
|
||||
**Labels:** `type: enhancement`, `priority: medium`, `component: scraper`
|
||||
**Description:**
|
||||
Add lxml fallback for malformed HTML.
|
||||
|
||||
**Current:** Uses built-in 'html.parser'
|
||||
**Proposed:** Try 'lxml' → 'html5lib' → 'html.parser'
|
||||
|
||||
**Benefits:**
|
||||
- Better handling of broken HTML
|
||||
- Faster parsing with lxml
|
||||
- More robust extraction
|
||||
|
||||
**Code Location:** `cli/doc_scraper.py:66-133` (extract_content)
|
||||
|
||||
---
|
||||
|
||||
#### Issue #9: Create Selector Validation Tool
|
||||
**Labels:** `type: feature`, `priority: medium`, `component: cli`
|
||||
**Description:**
|
||||
Interactive CLI tool to test CSS selectors before full scrape.
|
||||
|
||||
**Features:**
|
||||
- Input URL + selector
|
||||
- Preview extracted content
|
||||
- Suggest alternative selectors
|
||||
- Test code block detection
|
||||
- Validate before scraping
|
||||
|
||||
**New file:** `cli/validate_selectors.py`
|
||||
|
||||
---
|
||||
|
||||
#### Issue #10: Implement Incremental Updates
|
||||
**Labels:** `type: feature`, `priority: low`, `component: scraper`
|
||||
**Description:**
|
||||
Only re-scrape changed pages.
|
||||
|
||||
**Features:**
|
||||
- Track page modification times (Last-Modified header)
|
||||
- Store checksums/hashes
|
||||
- Compare on re-run
|
||||
- Update only changed content
|
||||
- Preserve local annotations
|
||||
|
||||
---
|
||||
|
||||
### 🆕 Advanced Features (Milestone: v2.0.0)
|
||||
|
||||
#### Issue #11: Parallel Scraping with Async
|
||||
**Labels:** `type: performance`, `priority: medium`, `component: scraper`
|
||||
**Description:**
|
||||
Implement async requests for faster scraping.
|
||||
|
||||
**Current:** Sequential requests (slow)
|
||||
**Proposed:**
|
||||
- `asyncio` + `aiohttp`
|
||||
- Configurable concurrency (default: 5)
|
||||
- Respect rate limiting
|
||||
- Thread pool for CPU-bound work
|
||||
|
||||
**Expected improvement:** 3-5x faster scraping
|
||||
|
||||
---
|
||||
|
||||
#### Issue #12: Image and Diagram Extraction
|
||||
**Labels:** `type: feature`, `priority: low`, `component: scraper`
|
||||
**Description:**
|
||||
Extract images with alt-text and captions.
|
||||
|
||||
**Use cases:**
|
||||
- Architecture diagrams
|
||||
- Flow charts
|
||||
- Screenshots
|
||||
- Code visual examples
|
||||
|
||||
**Storage:**
|
||||
- Download to `assets/images/`
|
||||
- Store alt-text and captions
|
||||
- Reference in SKILL.md
|
||||
|
||||
---
|
||||
|
||||
#### Issue #13: Export to Multiple Formats
|
||||
**Labels:** `type: feature`, `priority: low`, `component: cli`
|
||||
**Description:**
|
||||
Support export beyond Claude .zip format.
|
||||
|
||||
**Formats:**
|
||||
- Markdown (flat structure)
|
||||
- PDF (with styling)
|
||||
- EPUB (e-book format)
|
||||
- Docusaurus (documentation site)
|
||||
- MkDocs format
|
||||
- JSON API format
|
||||
|
||||
**New file:** `cli/export_skill.py`
|
||||
|
||||
---
|
||||
|
||||
#### Issue #14: Interactive Config Builder
|
||||
**Labels:** `type: feature`, `priority: medium`, `component: cli`
|
||||
**Description:**
|
||||
Web-based or TUI config builder.
|
||||
|
||||
**Features:**
|
||||
- Test URL selector in real-time
|
||||
- Preview categorization
|
||||
- Estimate page count live
|
||||
- Save/export config
|
||||
- Import from existing site structure
|
||||
|
||||
**Options:**
|
||||
- Terminal UI (textual library)
|
||||
- Web UI (Flask + React)
|
||||
- Electron app
|
||||
|
||||
---
|
||||
|
||||
#### Issue #15: Cloud Deployment Option
|
||||
**Labels:** `type: feature`, `priority: low`, `component: deployment`
|
||||
**Description:**
|
||||
Deploy as cloud service.
|
||||
|
||||
**Features:**
|
||||
- Web interface for scraping
|
||||
- Job queue system
|
||||
- Scheduled re-scraping
|
||||
- Multi-user support
|
||||
- API endpoints
|
||||
|
||||
**Tech stack:**
|
||||
- Backend: FastAPI
|
||||
- Queue: Celery + Redis
|
||||
- Database: PostgreSQL
|
||||
- Hosting: Docker + Kubernetes
|
||||
|
||||
---
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
#### Issue #16: Fix Package Path in Output
|
||||
**Labels:** `type: bug`, `priority: low`, `component: cli`
|
||||
**Description:**
|
||||
doc_scraper.py shows wrong path: `/mnt/skills/examples/skill-creator/scripts/cli/package_skill.py`
|
||||
|
||||
**Expected:** `python3 cli/package_skill.py output/godot/`
|
||||
|
||||
**Code Location:** `cli/doc_scraper.py:789` (end of main())
|
||||
|
||||
---
|
||||
|
||||
#### Issue #17: Handle Network Timeouts Gracefully
|
||||
**Labels:** `type: bug`, `priority: medium`, `component: scraper`
|
||||
**Description:**
|
||||
Improve error handling for network failures.
|
||||
|
||||
**Current behavior:** Crashes on timeout
|
||||
**Expected:** Retry with exponential backoff, skip after 3 attempts
|
||||
|
||||
---
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
#### Issue #18: Create Video Tutorial Series
|
||||
**Labels:** `type: documentation`, `priority: medium`, `component: website`
|
||||
**Description:**
|
||||
YouTube tutorial series:
|
||||
1. Quick Start (5 min)
|
||||
2. Custom Config Creation (10 min)
|
||||
3. MCP Integration Guide (8 min)
|
||||
4. Large Documentation Handling (12 min)
|
||||
5. Enhancement Deep Dive (15 min)
|
||||
|
||||
---
|
||||
|
||||
#### Issue #19: Write Contributing Guide
|
||||
**Labels:** `type: documentation`, `priority: medium`, `component: documentation`
|
||||
**Description:**
|
||||
Create CONTRIBUTING.md with:
|
||||
- Code style guidelines
|
||||
- Testing requirements
|
||||
- PR process
|
||||
- Issue templates
|
||||
- Development setup
|
||||
|
||||
---
|
||||
|
||||
### 🧪 Testing
|
||||
|
||||
#### Issue #20: Increase Test Coverage to 90%+
|
||||
**Labels:** `type: tests`, `priority: medium`, `component: tests`
|
||||
**Description:**
|
||||
Current: 96 tests
|
||||
Target: 150+ tests with 90% coverage
|
||||
|
||||
**Areas needing coverage:**
|
||||
- Edge cases in language detection
|
||||
- Error handling paths
|
||||
- MCP server tools
|
||||
- Enhancement scripts
|
||||
- Packaging utilities
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Custom Fields for Project Board
|
||||
|
||||
Add these custom fields to track more information:
|
||||
|
||||
1. **Effort** (Single Select)
|
||||
- XS (< 2 hours)
|
||||
- S (2-4 hours)
|
||||
- M (1-2 days)
|
||||
- L (3-5 days)
|
||||
- XL (1-2 weeks)
|
||||
|
||||
2. **Impact** (Single Select)
|
||||
- Low
|
||||
- Medium
|
||||
- High
|
||||
- Critical
|
||||
|
||||
3. **Category** (Single Select)
|
||||
- Feature
|
||||
- Bug Fix
|
||||
- Documentation
|
||||
- Infrastructure
|
||||
- Marketing
|
||||
|
||||
4. **Assignee** (Person)
|
||||
5. **Due Date** (Date)
|
||||
6. **Dependencies** (Text) - Link to blocking issues
|
||||
|
||||
---
|
||||
|
||||
## 📋 Quick Setup Steps
|
||||
|
||||
### Option 1: Manual Setup (Web Interface)
|
||||
|
||||
1. **Go to:** https://github.com/yusufkaraaslan/Skill_Seekers
|
||||
2. **Click:** "Projects" tab → "New project"
|
||||
3. **Select:** "Table" layout
|
||||
4. **Name:** "Skill Seekers Development Roadmap"
|
||||
5. **Create columns:** Backlog, Ready, In Progress, In Review, Done, Blocked
|
||||
6. **Add custom fields** (listed above)
|
||||
7. **Go to "Issues"** → Create labels (copy from above)
|
||||
8. **Go to "Milestones"** → Create 3 milestones
|
||||
9. **Create issues** (copy descriptions above)
|
||||
10. **Add issues to project board**
|
||||
|
||||
### Option 2: GitHub CLI (After Installation)
|
||||
|
||||
```bash
|
||||
# Install GitHub CLI
|
||||
brew install gh # macOS
|
||||
# or
|
||||
sudo apt install gh # Linux
|
||||
|
||||
# Authenticate
|
||||
gh auth login
|
||||
|
||||
# Create project (beta feature)
|
||||
gh project create --title "Skill Seekers Development Roadmap" --owner yusufkaraaslan
|
||||
|
||||
# Create labels
|
||||
gh label create "priority: critical" --color "d73a4a"
|
||||
gh label create "priority: high" --color "ff9800"
|
||||
gh label create "priority: medium" --color "ffeb3b"
|
||||
gh label create "priority: low" --color "4caf50"
|
||||
gh label create "type: feature" --color "0052cc"
|
||||
gh label create "type: bug" --color "d73a4a"
|
||||
gh label create "type: enhancement" --color "a2eeef"
|
||||
gh label create "component: scraper" --color "5319e7"
|
||||
gh label create "component: website" --color "1d76db"
|
||||
|
||||
# Create milestone
|
||||
gh milestone create "v1.1.0 - Website Launch" --due "2025-11-03"
|
||||
|
||||
# Create issues (example)
|
||||
gh issue create --title "Create skillseekersweb.com Landing Page" \
|
||||
--body "Design and implement professional landing page..." \
|
||||
--label "type: feature,priority: high,component: website" \
|
||||
--milestone "v1.1.0 - Website Launch"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Recommended Priority Order
|
||||
|
||||
### Week 1: Website Foundation
|
||||
1. Issue #1: Landing page
|
||||
2. Issue #2: Documentation migration
|
||||
3. Issue #5: SEO optimization
|
||||
|
||||
### Week 2: Core Improvements
|
||||
4. Issue #6: URL normalization
|
||||
5. Issue #7: Memory optimization
|
||||
6. Issue #9: Selector validation tool
|
||||
|
||||
### Week 3-4: Polish & Growth
|
||||
7. Issue #3: Preset showcase
|
||||
8. Issue #4: Blog setup
|
||||
9. Issue #18: Video tutorials
|
||||
|
||||
---
|
||||
|
||||
## 📊 Success Metrics
|
||||
|
||||
Track these KPIs on your project board:
|
||||
|
||||
- **GitHub Stars:** Target 1,000+ by end of month
|
||||
- **Website Traffic:** Target 500+ visitors/week
|
||||
- **Issue Resolution:** Close 10+ issues/week
|
||||
- **Documentation Coverage:** 100% of features documented
|
||||
- **Test Coverage:** 90%+
|
||||
- **Response Time:** Reply to issues within 24 hours
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Community Engagement
|
||||
|
||||
Add these as recurring tasks:
|
||||
|
||||
- **Weekly:** Respond to GitHub issues/PRs
|
||||
- **Bi-weekly:** Publish blog post
|
||||
- **Monthly:** Release new version
|
||||
- **Quarterly:** Major feature release
|
||||
|
||||
---
|
||||
|
||||
This project board structure will help organize development, track progress, and coordinate with contributors!
|
||||
149
.github/SETUP_GUIDE.md
vendored
149
.github/SETUP_GUIDE.md
vendored
@@ -1,149 +0,0 @@
|
||||
# GitHub Project Setup Guide
|
||||
|
||||
Quick guide to set up GitHub Issues and Project Board for Skill Seeker MCP development.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Create GitHub Issues (5 minutes)
|
||||
|
||||
### Quick Method:
|
||||
1. Open: https://github.com/yusufkaraaslan/Skill_Seekers/issues/new
|
||||
2. Open in another tab: `.github/ISSUES_TO_CREATE.md` (in your repo)
|
||||
3. Copy title and body for each issue
|
||||
4. Create 4 issues
|
||||
|
||||
### Issues to Create:
|
||||
|
||||
**Issue #1:**
|
||||
- Title: `Fix 3 test failures (warnings vs errors handling)`
|
||||
- Labels: `bug`, `tests`, `good first issue`
|
||||
- Body: Copy from ISSUES_TO_CREATE.md (Issue 1)
|
||||
|
||||
**Issue #2:**
|
||||
- Title: `Create comprehensive MCP setup guide for Claude Code`
|
||||
- Labels: `documentation`, `mcp`, `enhancement`
|
||||
- Body: Copy from ISSUES_TO_CREATE.md (Issue 2)
|
||||
|
||||
**Issue #3:**
|
||||
- Title: `Test MCP server with actual Claude Code instance`
|
||||
- Labels: `testing`, `mcp`, `priority-high`
|
||||
- Body: Copy from ISSUES_TO_CREATE.md (Issue 3)
|
||||
|
||||
**Issue #4:**
|
||||
- Title: `Update all documentation for new monorepo structure`
|
||||
- Labels: `documentation`, `breaking-change`
|
||||
- Body: Copy from ISSUES_TO_CREATE.md (Issue 4)
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Create GitHub Project Board (2 minutes)
|
||||
|
||||
### Steps:
|
||||
1. Go to: https://github.com/yusufkaraaslan/Skill_Seekers/projects
|
||||
2. Click **"New project"**
|
||||
3. Choose **"Board"** template
|
||||
4. Name it: **"Skill Seeker MCP Development"**
|
||||
5. Click **"Create project"**
|
||||
|
||||
### Configure Board:
|
||||
|
||||
**Default columns:**
|
||||
- Todo
|
||||
- In Progress
|
||||
- Done
|
||||
|
||||
**Add custom column (optional):**
|
||||
- Testing
|
||||
|
||||
**Your board will look like:**
|
||||
```
|
||||
📋 Todo | 🚧 In Progress | 🧪 Testing | ✅ Done
|
||||
-----------------|-----------------│-------------|---------
|
||||
Issue #1 | | |
|
||||
Issue #2 | | |
|
||||
Issue #3 | | |
|
||||
Issue #4 | | |
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Add Issues to Project
|
||||
|
||||
1. In your project board, click **"Add item"**
|
||||
2. Search for your issues (#1, #2, #3, #4)
|
||||
3. Add them to "Todo" column
|
||||
4. Done!
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Start Working
|
||||
|
||||
1. Move **Issue #1** to "In Progress"
|
||||
2. Work on fixing tests
|
||||
3. When done, move to "Done"
|
||||
4. Repeat!
|
||||
|
||||
---
|
||||
|
||||
## Alternative: Quick Setup Script
|
||||
|
||||
```bash
|
||||
# View issue templates
|
||||
cat .github/ISSUES_TO_CREATE.md
|
||||
|
||||
# Get direct URLs for creating issues
|
||||
.github/create_issues.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
### Linking Issues to PRs
|
||||
When you create a PR, mention the issue:
|
||||
```
|
||||
Fixes #1
|
||||
```
|
||||
|
||||
### Closing Issues Automatically
|
||||
In commit message:
|
||||
```
|
||||
Fix test failures
|
||||
|
||||
Fixes #1
|
||||
```
|
||||
|
||||
### Project Automation
|
||||
GitHub Projects can auto-move issues:
|
||||
- PR opened → Move to "In Progress"
|
||||
- PR merged → Move to "Done"
|
||||
|
||||
Enable in Project Settings → Workflows
|
||||
|
||||
---
|
||||
|
||||
## Your Workflow
|
||||
|
||||
```
|
||||
Daily:
|
||||
1. Check Project Board
|
||||
2. Pick task from "Todo"
|
||||
3. Move to "In Progress"
|
||||
4. Work on it
|
||||
5. Create PR (mention issue number)
|
||||
6. Move to "Testing"
|
||||
7. Merge PR → Auto moves to "Done"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Links
|
||||
|
||||
- **Issues:** https://github.com/yusufkaraaslan/Skill_Seekers/issues
|
||||
- **Projects:** https://github.com/yusufkaraaslan/Skill_Seekers/projects
|
||||
- **New Issue:** https://github.com/yusufkaraaslan/Skill_Seekers/issues/new
|
||||
- **New Project:** https://github.com/yusufkaraaslan/Skill_Seekers/projects/new
|
||||
|
||||
---
|
||||
|
||||
Need help? Check `.github/ISSUES_TO_CREATE.md` for full issue content!
|
||||
279
.github/SETUP_INSTRUCTIONS.md
vendored
279
.github/SETUP_INSTRUCTIONS.md
vendored
@@ -1,279 +0,0 @@
|
||||
# 🚀 GitHub Project Board Setup Instructions
|
||||
|
||||
## ✅ What's Been Created
|
||||
|
||||
All files are ready and committed locally. Here's what you have:
|
||||
|
||||
### 📁 Files Created
|
||||
- `.github/PROJECT_BOARD_SETUP.md` - Complete setup guide with 20 issues
|
||||
- `.github/ISSUE_TEMPLATE/feature_request.md` - Feature request template
|
||||
- `.github/ISSUE_TEMPLATE/bug_report.md` - Bug report template
|
||||
- `.github/ISSUE_TEMPLATE/documentation.md` - Documentation issue template
|
||||
- `.github/PULL_REQUEST_TEMPLATE.md` - Pull request template
|
||||
|
||||
### 📊 Project Structure Defined
|
||||
- **6 Columns:** Backlog, Ready, In Progress, In Review, Done, Blocked
|
||||
- **20 Pre-defined Issues:** Covering website, improvements, features
|
||||
- **3 Milestones:** v1.1.0, v1.2.0, v2.0.0
|
||||
- **15+ Labels:** Priority, type, component, status categories
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Next Steps (Do These Now)
|
||||
|
||||
### Step 1: Push to GitHub
|
||||
```bash
|
||||
cd /Users/ludu/Skill_Seekers
|
||||
git push origin main
|
||||
```
|
||||
|
||||
**If you get permission error:** You may need to authenticate with the correct account.
|
||||
|
||||
```bash
|
||||
# Check current user
|
||||
git config user.name
|
||||
git config user.email
|
||||
|
||||
# Update if needed
|
||||
git config user.name "yusufkaraaslan"
|
||||
git config user.email "your-email@example.com"
|
||||
|
||||
# Try push again
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### Step 2: Create the Project Board (Web Interface)
|
||||
|
||||
1. **Go to:** https://github.com/yusufkaraaslan/Skill_Seekers
|
||||
|
||||
2. **Click "Projects" tab** → "New project"
|
||||
|
||||
3. **Select "Table" layout**
|
||||
|
||||
4. **Name:** "Skill Seekers Development Roadmap"
|
||||
|
||||
5. **Add columns (Status field):**
|
||||
- 📋 Backlog
|
||||
- 🎯 Ready
|
||||
- 🚀 In Progress
|
||||
- 👀 In Review
|
||||
- ✅ Done
|
||||
- 🔄 Blocked
|
||||
|
||||
6. **Add custom fields:**
|
||||
- **Effort** (Single Select): XS, S, M, L, XL
|
||||
- **Impact** (Single Select): Low, Medium, High, Critical
|
||||
- **Category** (Single Select): Feature, Bug Fix, Documentation, Infrastructure
|
||||
|
||||
### Step 3: Create Labels
|
||||
|
||||
Go to **Issues** → **Labels** → Click "New label" for each:
|
||||
|
||||
**Priority Labels:**
|
||||
```
|
||||
priority: critical | Color: d73a4a (Red)
|
||||
priority: high | Color: ff9800 (Orange)
|
||||
priority: medium | Color: ffeb3b (Yellow)
|
||||
priority: low | Color: 4caf50 (Green)
|
||||
```
|
||||
|
||||
**Type Labels:**
|
||||
```
|
||||
type: feature | Color: 0052cc (Blue)
|
||||
type: bug | Color: d73a4a (Red)
|
||||
type: enhancement | Color: a2eeef (Light Blue)
|
||||
type: documentation | Color: 0075ca (Blue)
|
||||
type: refactor | Color: fbca04 (Yellow)
|
||||
type: performance | Color: d4c5f9 (Purple)
|
||||
type: security | Color: ee0701 (Red)
|
||||
```
|
||||
|
||||
**Component Labels:**
|
||||
```
|
||||
component: scraper | Color: 5319e7 (Purple)
|
||||
component: enhancement | Color: 1d76db (Blue)
|
||||
component: mcp | Color: 0e8a16 (Green)
|
||||
component: cli | Color: fbca04 (Yellow)
|
||||
component: website | Color: 1d76db (Blue)
|
||||
component: tests | Color: d4c5f9 (Purple)
|
||||
```
|
||||
|
||||
**Status Labels:**
|
||||
```
|
||||
status: blocked | Color: b60205 (Red)
|
||||
status: needs-discussion | Color: d876e3 (Pink)
|
||||
status: help-wanted | Color: 008672 (Teal)
|
||||
status: good-first-issue | Color: 7057ff (Purple)
|
||||
```
|
||||
|
||||
### Step 4: Create Milestones
|
||||
|
||||
Go to **Issues** → **Milestones** → "New milestone"
|
||||
|
||||
**Milestone 1:**
|
||||
- Title: `v1.1.0 - Website Launch`
|
||||
- Due date: 2 weeks from now
|
||||
- Description: Launch skillseekersweb.com with documentation
|
||||
|
||||
**Milestone 2:**
|
||||
- Title: `v1.2.0 - Core Improvements`
|
||||
- Due date: 1 month from now
|
||||
- Description: Address technical debt and user feedback
|
||||
|
||||
**Milestone 3:**
|
||||
- Title: `v2.0.0 - Advanced Features`
|
||||
- Due date: 2 months from now
|
||||
- Description: Major feature additions
|
||||
|
||||
### Step 5: Create Issues
|
||||
|
||||
Open `.github/PROJECT_BOARD_SETUP.md` and copy the issue descriptions.
|
||||
|
||||
For each issue:
|
||||
1. Go to **Issues** → "New issue"
|
||||
2. Copy title and description from PROJECT_BOARD_SETUP.md
|
||||
3. Add appropriate labels
|
||||
4. Assign to milestone
|
||||
5. Add to project board
|
||||
6. Set status (Backlog, Ready, etc.)
|
||||
|
||||
**Quick Copy Issues List:**
|
||||
|
||||
**High Priority (Create First):**
|
||||
1. Create skillseekersweb.com Landing Page
|
||||
2. Migrate Documentation to Website
|
||||
3. Implement URL Normalization
|
||||
4. Memory Optimization for Large Docs
|
||||
|
||||
**Medium Priority:**
|
||||
5. Create Preset Showcase Gallery
|
||||
6. SEO Optimization
|
||||
7. Add HTML Parser Fallback
|
||||
8. Create Selector Validation Tool
|
||||
|
||||
**Lower Priority:**
|
||||
9. Set Up Blog with Release Notes
|
||||
10. Incremental Updates System
|
||||
11-20. See PROJECT_BOARD_SETUP.md for full list
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start Commands (If GitHub CLI is installed)
|
||||
|
||||
If you want to automate this, install GitHub CLI first:
|
||||
|
||||
```bash
|
||||
# macOS
|
||||
brew install gh
|
||||
|
||||
# Authenticate
|
||||
gh auth login
|
||||
|
||||
# Create labels (run from repo directory)
|
||||
cd /Users/ludu/Skill_Seekers
|
||||
|
||||
gh label create "priority: critical" --color "d73a4a" --description "Must be fixed immediately"
|
||||
gh label create "priority: high" --color "ff9800" --description "Important feature/fix"
|
||||
gh label create "priority: medium" --color "ffeb3b" --description "Normal priority"
|
||||
gh label create "priority: low" --color "4caf50" --description "Nice to have"
|
||||
|
||||
gh label create "type: feature" --color "0052cc" --description "New functionality"
|
||||
gh label create "type: bug" --color "d73a4a" --description "Something isn't working"
|
||||
gh label create "type: enhancement" --color "a2eeef" --description "Improve existing feature"
|
||||
gh label create "type: documentation" --color "0075ca" --description "Documentation updates"
|
||||
|
||||
gh label create "component: scraper" --color "5319e7" --description "Core scraping engine"
|
||||
gh label create "component: website" --color "1d76db" --description "Website/documentation"
|
||||
gh label create "component: mcp" --color "0e8a16" --description "MCP server integration"
|
||||
|
||||
# Create milestones
|
||||
gh milestone create "v1.1.0 - Website Launch" --due "2025-11-03" --description "Launch skillseekersweb.com"
|
||||
gh milestone create "v1.2.0 - Core Improvements" --due "2025-11-17" --description "Technical debt and feedback"
|
||||
gh milestone create "v2.0.0 - Advanced Features" --due "2025-12-20" --description "Major feature additions"
|
||||
|
||||
# Create first issue (example)
|
||||
gh issue create \
|
||||
--title "Create skillseekersweb.com Landing Page" \
|
||||
--body "Design and implement professional landing page with hero section, features, GitHub stats, responsive design" \
|
||||
--label "type: feature,priority: high,component: website" \
|
||||
--milestone "v1.1.0 - Website Launch"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Checklist
|
||||
|
||||
Use this checklist to track your setup:
|
||||
|
||||
### Git & GitHub
|
||||
- [ ] Push local changes to GitHub (`git push origin main`)
|
||||
- [ ] Verify files appear in repo (check .github/ folder)
|
||||
|
||||
### Project Board
|
||||
- [ ] Create new project "Skill Seekers Development Roadmap"
|
||||
- [ ] Add 6 status columns
|
||||
- [ ] Add custom fields (Effort, Impact, Category)
|
||||
|
||||
### Labels
|
||||
- [ ] Create 4 priority labels
|
||||
- [ ] Create 7 type labels
|
||||
- [ ] Create 6 component labels
|
||||
- [ ] Create 4 status labels
|
||||
|
||||
### Milestones
|
||||
- [ ] Create v1.1.0 milestone
|
||||
- [ ] Create v1.2.0 milestone
|
||||
- [ ] Create v2.0.0 milestone
|
||||
|
||||
### Issues
|
||||
- [ ] Create Issue #1: Landing Page (HIGH)
|
||||
- [ ] Create Issue #2: Documentation Migration (HIGH)
|
||||
- [ ] Create Issue #3: Preset Showcase (MEDIUM)
|
||||
- [ ] Create Issue #4: Blog Setup (MEDIUM)
|
||||
- [ ] Create Issue #5: SEO Optimization (MEDIUM)
|
||||
- [ ] Create Issue #6: URL Normalization (HIGH)
|
||||
- [ ] Create Issue #7: Memory Optimization (HIGH)
|
||||
- [ ] Create Issue #8: Parser Fallback (MEDIUM)
|
||||
- [ ] Create Issue #9: Selector Validation Tool (MEDIUM)
|
||||
- [ ] Create Issue #10: Incremental Updates (LOW)
|
||||
- [ ] Add remaining 10 issues (see PROJECT_BOARD_SETUP.md)
|
||||
|
||||
### Verification
|
||||
- [ ] All issues appear in project board
|
||||
- [ ] Issues have correct labels and milestones
|
||||
- [ ] Issue templates work when creating new issues
|
||||
- [ ] PR template appears when creating PRs
|
||||
|
||||
---
|
||||
|
||||
## 🎯 After Setup
|
||||
|
||||
Once your project board is set up:
|
||||
|
||||
1. **Start with Milestone v1.1.0** - Website development
|
||||
2. **Move issues to "Ready"** when prioritized
|
||||
3. **Move to "In Progress"** when working on them
|
||||
4. **Update regularly** - Keep the board current
|
||||
5. **Close completed issues** - Mark as Done
|
||||
|
||||
---
|
||||
|
||||
## 📊 View Your Progress
|
||||
|
||||
Once set up, you can view at:
|
||||
- **Project Board:** https://github.com/users/yusufkaraaslan/projects/1
|
||||
- **Issues:** https://github.com/yusufkaraaslan/Skill_Seekers/issues
|
||||
- **Milestones:** https://github.com/yusufkaraaslan/Skill_Seekers/milestones
|
||||
|
||||
---
|
||||
|
||||
## ❓ Need Help?
|
||||
|
||||
If you run into issues:
|
||||
1. Check `.github/PROJECT_BOARD_SETUP.md` for detailed information
|
||||
2. GitHub's Project Board docs: https://docs.github.com/en/issues/planning-and-tracking-with-projects
|
||||
3. Ask me! I can help troubleshoot any issues
|
||||
|
||||
---
|
||||
|
||||
**Your project board infrastructure is ready to go! 🚀**
|
||||
Reference in New Issue
Block a user