Commit Graph

7 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
b72073a482 docs: Add user config directory documentation (ref #262)
Updated documentation to clarify the three config file locations:

1. README.md:
   - Added "Where to Place Custom Configs" section
   - Explains all three options: user dir, current dir, absolute path
   - Shows config resolution order

2. BULLETPROOF_QUICKSTART.md:
   - Added "Where to Save Custom Configs" section
   - Practical examples for beginners
   - Clarifies when to use each option

3. TROUBLESHOOTING.md:
   - Enhanced "Config File Not Found" section
   - Shows all search locations
   - Provides 5 clear solutions

These docs address the confusion reported in #262 about where to
place custom config files. Users now have clear guidance on using
the new ~/.config/skill-seekers/configs/ directory.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-27 22:03:37 +03:00
yusyus
ffa745fbc7 fix: Add CSS selectors to test config in BULLETPROOF_QUICKSTART.md
The test config was missing CSS selectors, causing the scraper to fail
with "No content" errors on Tailwind CSS documentation.

Changes:
- Added selectors section with proper CSS selectors for Tailwind docs
- Added Windows PowerShell alternative since cat/EOF doesn't work there
- Includes main_content, title, and code_blocks selectors

This fixes the "No content" error reported in issue #261.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-22 22:59:51 +03:00
yusyus
393d9e3c88 fix: Add missing package installation step in BULLETPROOF_QUICKSTART.md
Fixes #261

The guide was missing the critical `pip install -e .` step, which caused
the skill-seekers command to not be found on Windows (and all platforms).

Changes:
- Updated Step 4 to use `pip install -e .` instead of manually installing deps
- Added explanation of what the command does
- Updated troubleshooting section for "command not found" errors
- Added fallback for pip command issues

This ensures the package is properly installed and console scripts are
registered, making the skill-seekers command available in PATH.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-22 20:31:09 +03:00
yusyus
4080794eb7 docs: Update all remaining old command patterns to unified CLI
Updated 96 command examples across all documentation files:
- README.md: 54 updates
- QUICKSTART.md: 26 updates
- BULLETPROOF_QUICKSTART.md: 11 updates
- TROUBLESHOOTING.md: 5 updates

Changes:
- python3 cli/doc_scraper.py → skill-seekers scrape
- python3 cli/github_scraper.py → skill-seekers github
- python3 cli/pdf_scraper.py → skill-seekers pdf
- python3 cli/unified_scraper.py → skill-seekers unified
- python3 cli/enhance_skill*.py → skill-seekers enhance
- python3 cli/package_skill.py → skill-seekers package
- python3 cli/upload_skill.py → skill-seekers upload
- python3 cli/estimate_pages.py → skill-seekers estimate

Advanced tools (no entry points yet):
- python3 cli/split_config.py → python3 -m skill_seekers.cli.split_config
- python3 cli/generate_router.py → python3 -m skill_seekers.cli.generate_router
- python3 cli/package_multi.py → python3 -m skill_seekers.cli.package_multi

Result:  0 old patterns remaining in all documentation

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-10 21:38:11 +03:00
Preston Brown
de5344caf9 Add virtual environment setup and minimal dependencies (#149)
## Changes
- Add virtual environment setup instructions to all docs
- Create requirements.txt with minimal dependencies (13 packages)
- Make anthropic optional (only needed for API enhancement)
- Clarify path notation (~ = $HOME, /Users/yourname examples)
- Add venv activation reminders throughout documentation

## Files Changed
- README.md: Added venv setup section to CLI method
- BULLETPROOF_QUICKSTART.md: Replaced Step 4 with venv setup
- CLAUDE.md: Updated Prerequisites with venv instructions
- requirements.txt: Created with minimal deps (requests, beautifulsoup4, pytest)

## Why
- Prevents package conflicts and permission issues
- Standard Python development practice
- Enables proper pytest usage without pipx complications
- Makes setup clearer for beginners
2025-10-22 21:54:05 +03:00
yusyus
9028974da9 Fix Issue #8: Add bulletproof setup and prerequisites
Addresses community feedback about missing setup steps.

New Documentation:
+ BULLETPROOF_QUICKSTART.md - Complete beginner guide
  - Step-by-step Python/Git installation
  - Every step with expected output
  - Troubleshooting for each step
  - Test example (5-page scrape)
  - 15-30 minute complete setup

+ TROUBLESHOOTING.md - Comprehensive troubleshooting
  - Installation issues (Python, pip, permissions)
  - Runtime issues (file not found, configs)
  - MCP setup issues (placeholder paths!)
  - Scraping issues (slow, empty content)
  - Platform-specific (macOS/Linux/Windows)
  - Verification commands

Setup Script Improvements:
 Fixed setup_mcp.sh path expansion
  - Now shows ACTUAL paths (not $REPO_PATH placeholder)
  - Verifies paths exist after writing config
  - Shows config contents for verification
  - Tests MCP server path validity
  - Clear warning about placeholders

README Updates:
 Added Prerequisites section
  - Python 3.10+ requirement clear
  - Git requirement clear
  - Links to bulletproof guide
 Added git clone step to Quick Start
 Reorganized Documentation section
  - Getting Started (new, beginner, troubleshooting)
  - Guides (advanced topics)
  - Technical (architecture)

Fixes:
- Issue #8 - Prereqs to Getting Started
- Issue #114 on project board (H1.1)
- Placeholder path problem in MCP setup
- Missing beginner-friendly docs

Impact: New users can now get started without confusion!
2025-10-21 00:04:26 +03:00