From b72073a48285c5522956edc962343649d15f3787 Mon Sep 17 00:00:00 2001 From: yusyus Date: Tue, 27 Jan 2026 22:03:37 +0300 Subject: [PATCH] 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 --- BULLETPROOF_QUICKSTART.md | 41 +++++++++++++++++++++++++ README.md | 64 +++++++++++++++++++++++++++++++++++++++ TROUBLESHOOTING.md | 43 +++++++++++++++++++++----- 3 files changed, 141 insertions(+), 7 deletions(-) diff --git a/BULLETPROOF_QUICKSTART.md b/BULLETPROOF_QUICKSTART.md index 070f033..126c1c1 100644 --- a/BULLETPROOF_QUICKSTART.md +++ b/BULLETPROOF_QUICKSTART.md @@ -418,6 +418,47 @@ skill-seekers scrape \ --description "My favorite framework" ``` +### Where to Save Custom Configs + +You have three options for placing your custom config files: + +**Option 1: User Config Directory (Recommended)** + +```bash +# Create config in your home directory +mkdir -p ~/.config/skill-seekers/configs +cat > ~/.config/skill-seekers/configs/myproject.json << 'EOF' +{ + "name": "myproject", + "base_url": "https://docs.myproject.com/", + "max_pages": 50 +} +EOF + +# Use it +skill-seekers scrape --config myproject.json +``` + +**Option 2: Current Directory (Project-Specific)** + +```bash +# Create config in your project +mkdir -p configs +nano configs/myproject.json + +# Use it +skill-seekers scrape --config configs/myproject.json +``` + +**Option 3: Absolute Path** + +```bash +# Use any file path +skill-seekers scrape --config /full/path/to/config.json +``` + +The tool searches in this order: exact path → `./configs/` → `~/.config/skill-seekers/configs/` → API presets + ### Use with Claude Code (Advanced) If you have Claude Code installed: diff --git a/README.md b/README.md index de8bc0a..98644b9 100644 --- a/README.md +++ b/README.md @@ -1769,6 +1769,70 @@ nano configs/myframework.json skill-seekers scrape --config configs/myframework.json ``` +### Where to Place Custom Configs + +You have **three options** for placing your custom config files: + +#### Option A: User Config Directory (Recommended for Personal Configs) + +```bash +# Create your config in your home directory +mkdir -p ~/.config/skill-seekers/configs +cat > ~/.config/skill-seekers/configs/myproject.json << 'EOF' +{ + "name": "myproject", + "base_url": "https://docs.myproject.com/", + "max_pages": 50 +} +EOF + +# Use it (tool automatically finds it) +skill-seekers scrape --config myproject.json +# or +skill-seekers scrape --config configs/myproject.json +``` + +**Benefits:** +- ✅ Configs persist across project directories +- ✅ Separate from your project code +- ✅ Easy to manage personal configurations + +#### Option B: Current Directory (Good for Project-Specific Configs) + +```bash +# Create configs in your project folder +mkdir -p configs +cat > configs/myproject.json << 'EOF' +{ + "name": "myproject", + "base_url": "https://docs.myproject.com/" +} +EOF + +# Use it +skill-seekers scrape --config configs/myproject.json +``` + +**Benefits:** +- ✅ Config lives with your project +- ✅ Easy to commit to version control +- ✅ Team members can use the same config + +#### Option C: Absolute Path (For Configs Stored Elsewhere) + +```bash +# Use any file path +skill-seekers scrape --config /full/path/to/myconfig.json +``` + +**Config Resolution Order:** + +The tool searches for configs in this order: +1. Exact path as provided +2. `./configs/` (current directory) +3. `~/.config/skill-seekers/configs/` (user config directory) +4. SkillSeekersWeb.com API (preset configs) + ### Config Structure ```json diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 75b7ae9..6aa1720 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -111,22 +111,51 @@ FileNotFoundError: [Errno 2] No such file or directory: 'cli/doc_scraper.py' **Error:** ``` -FileNotFoundError: configs/react.json +❌ Error: Config file not found: configs/myconfig.json ``` +**Understanding Config Locations:** + +The tool searches for configs in this order: +1. Exact path as provided +2. `./configs/` (current directory) +3. `~/.config/skill-seekers/configs/` (user config directory) +4. SkillSeekersWeb.com API (preset configs) + **Solutions:** -1. **Check config exists:** + +1. **Place config in user directory (recommended for custom configs):** ```bash - ls configs/ - # Should show: godot.json, react.json, vue.json, etc. + mkdir -p ~/.config/skill-seekers/configs + cp myconfig.json ~/.config/skill-seekers/configs/ + + # Now you can use it from anywhere + skill-seekers scrape --config myconfig.json ``` -2. **Use full path:** +2. **Place config in current directory (project-specific):** ```bash - skill-seekers scrape --config $(pwd)/configs/react.json + mkdir -p configs + cp myconfig.json configs/ + + skill-seekers scrape --config configs/myconfig.json ``` -3. **Create missing config:** +3. **Use absolute path:** + ```bash + skill-seekers scrape --config /full/path/to/myconfig.json + ``` + +4. **Check if it's a preset config (auto-downloads):** + ```bash + # List all available presets + skill-seekers estimate --all + + # Use preset (auto-fetched from API) + skill-seekers scrape --config react.json + ``` + +5. **Create new config interactively:** ```bash skill-seekers scrape --interactive ```