ba9a8ff8b5
Documentation restructure: - New docs/getting-started/ guide (4 files: install, quick-start, first-skill, next-steps) - New docs/user-guide/ section (6 files: core concepts through troubleshooting) - New docs/reference/ section (CLI_REFERENCE, CONFIG_FORMAT, ENVIRONMENT_VARIABLES, MCP_REFERENCE) - New docs/advanced/ section (custom-workflows, mcp-server, multi-source) - New docs/ARCHITECTURE.md - system architecture overview - Archived legacy files (QUICKSTART.md, QUICK_REFERENCE.md, docs/guides/USAGE.md) to docs/archive/legacy/ Chinese (zh-CN) translations: - Full zh-CN mirror of all user-facing docs (getting-started, user-guide, reference, advanced) - GitHub Actions workflow for translation sync (.github/workflows/translate-docs.yml) - Translation sync checker script (scripts/check_translation_sync.sh) - Translation helper script (scripts/translate_doc.py) Content updates: - CHANGELOG.md: [Unreleased] → [3.1.0] - 2026-02-22 - README.md: updated with new doc structure links - AGENTS.md: updated agent documentation - docs/features/UNIFIED_SCRAPING.md: updated for unified scraper workflow JSON config Analysis/planning artifacts (kept for reference): - DOCUMENTATION_OVERHAUL_PLAN.md, DOCUMENTATION_OVERHAUL_SUMMARY.md - FEATURE_GAP_ANALYSIS.md, IMPLEMENTATION_GAPS_ANALYSIS.md, CREATE_COMMAND_COVERAGE_ANALYSIS.md - CHINESE_TRANSLATION_IMPLEMENTATION_SUMMARY.md, ISSUE_260_UPDATE.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
200 lines
4.9 KiB
Markdown
200 lines
4.9 KiB
Markdown
# Skill Seekers Documentation
|
|
|
|
> **Complete documentation for Skill Seekers v3.1.0**
|
|
|
|
---
|
|
|
|
## Welcome!
|
|
|
|
This is the official documentation for **Skill Seekers** - the universal tool for converting documentation, code, and PDFs into AI-ready skills.
|
|
|
|
---
|
|
|
|
## Where Should I Start?
|
|
|
|
### 🚀 I'm New Here
|
|
|
|
Start with our **Getting Started** guides:
|
|
|
|
1. [Installation](getting-started/01-installation.md) - Install Skill Seekers
|
|
2. [Quick Start](getting-started/02-quick-start.md) - Create your first skill in 3 commands
|
|
3. [Your First Skill](getting-started/03-your-first-skill.md) - Complete walkthrough
|
|
4. [Next Steps](getting-started/04-next-steps.md) - Where to go from here
|
|
|
|
### 📖 I Want to Learn
|
|
|
|
Explore our **User Guides**:
|
|
|
|
- [Core Concepts](user-guide/01-core-concepts.md) - How Skill Seekers works
|
|
- [Scraping Guide](user-guide/02-scraping.md) - All scraping options
|
|
- [Enhancement Guide](user-guide/03-enhancement.md) - AI enhancement explained
|
|
- [Packaging Guide](user-guide/04-packaging.md) - Export to platforms
|
|
- [Workflows Guide](user-guide/05-workflows.md) - Enhancement workflows
|
|
- [Troubleshooting](user-guide/06-troubleshooting.md) - Common issues
|
|
|
|
### 📚 I Need Reference
|
|
|
|
Look up specific information:
|
|
|
|
- [CLI Reference](reference/CLI_REFERENCE.md) - All 20 commands
|
|
- [MCP Reference](reference/MCP_REFERENCE.md) - 26 MCP tools
|
|
- [Config Format](reference/CONFIG_FORMAT.md) - JSON specification
|
|
- [Environment Variables](reference/ENVIRONMENT_VARIABLES.md) - All env vars
|
|
|
|
### 🚀 I'm Ready for Advanced Topics
|
|
|
|
Power user features:
|
|
|
|
- [MCP Server Setup](advanced/mcp-server.md) - MCP integration
|
|
- [MCP Tools Deep Dive](advanced/mcp-tools.md) - Advanced MCP usage
|
|
- [Custom Workflows](advanced/custom-workflows.md) - Create workflows
|
|
- [Multi-Source Scraping](advanced/multi-source.md) - Combine sources
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
### The 3 Commands
|
|
|
|
```bash
|
|
# 1. Install
|
|
pip install skill-seekers
|
|
|
|
# 2. Create skill
|
|
skill-seekers create https://docs.django.com/
|
|
|
|
# 3. Package for Claude
|
|
skill-seekers package output/django --target claude
|
|
```
|
|
|
|
### Common Commands
|
|
|
|
```bash
|
|
# Scrape documentation
|
|
skill-seekers scrape --config react
|
|
|
|
# Analyze GitHub repo
|
|
skill-seekers github --repo facebook/react
|
|
|
|
# Extract PDF
|
|
skill-seekers pdf manual.pdf --name docs
|
|
|
|
# Analyze local code
|
|
skill-seekers analyze --directory ./my-project
|
|
|
|
# Enhance skill
|
|
skill-seekers enhance output/my-skill/
|
|
|
|
# Package for platform
|
|
skill-seekers package output/my-skill/ --target claude
|
|
|
|
# Upload
|
|
skill-seekers upload output/my-skill-claude.zip
|
|
|
|
# List workflows
|
|
skill-seekers workflows list
|
|
```
|
|
|
|
---
|
|
|
|
## Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── README.md # This file - start here
|
|
├── ARCHITECTURE.md # How docs are organized
|
|
│
|
|
├── getting-started/ # For new users
|
|
│ ├── 01-installation.md
|
|
│ ├── 02-quick-start.md
|
|
│ ├── 03-your-first-skill.md
|
|
│ └── 04-next-steps.md
|
|
│
|
|
├── user-guide/ # Common tasks
|
|
│ ├── 01-core-concepts.md
|
|
│ ├── 02-scraping.md
|
|
│ ├── 03-enhancement.md
|
|
│ ├── 04-packaging.md
|
|
│ ├── 05-workflows.md
|
|
│ └── 06-troubleshooting.md
|
|
│
|
|
├── reference/ # Technical reference
|
|
│ ├── CLI_REFERENCE.md # 20 commands
|
|
│ ├── MCP_REFERENCE.md # 26 MCP tools
|
|
│ ├── CONFIG_FORMAT.md # JSON spec
|
|
│ └── ENVIRONMENT_VARIABLES.md
|
|
│
|
|
└── advanced/ # Power user topics
|
|
├── mcp-server.md
|
|
├── mcp-tools.md
|
|
├── custom-workflows.md
|
|
└── multi-source.md
|
|
```
|
|
|
|
---
|
|
|
|
## By Use Case
|
|
|
|
### I Want to Build AI Skills
|
|
|
|
For Claude, Gemini, ChatGPT:
|
|
|
|
1. [Quick Start](getting-started/02-quick-start.md)
|
|
2. [Enhancement Guide](user-guide/03-enhancement.md)
|
|
3. [Workflows Guide](user-guide/05-workflows.md)
|
|
|
|
### I Want to Build RAG Pipelines
|
|
|
|
For LangChain, LlamaIndex, vector DBs:
|
|
|
|
1. [Core Concepts](user-guide/01-core-concepts.md)
|
|
2. [Packaging Guide](user-guide/04-packaging.md)
|
|
3. [MCP Reference](reference/MCP_REFERENCE.md)
|
|
|
|
### I Want AI Coding Assistance
|
|
|
|
For Cursor, Windsurf, Cline:
|
|
|
|
1. [Your First Skill](getting-started/03-your-first-skill.md)
|
|
2. [Local Codebase Analysis](user-guide/02-scraping.md#local-codebase-analysis)
|
|
3. `skill-seekers install-agent --agent cursor`
|
|
|
|
---
|
|
|
|
## Version Information
|
|
|
|
- **Current Version:** 3.1.0
|
|
- **Last Updated:** 2026-02-16
|
|
- **Python Required:** 3.10+
|
|
|
|
---
|
|
|
|
## Contributing to Documentation
|
|
|
|
Found an issue? Want to improve docs?
|
|
|
|
1. Edit files in the `docs/` directory
|
|
2. Follow the existing structure
|
|
3. Submit a PR
|
|
|
|
See [Contributing Guide](../CONTRIBUTING.md) for details.
|
|
|
|
---
|
|
|
|
## External Links
|
|
|
|
- **Main Repository:** https://github.com/yusufkaraaslan/Skill_Seekers
|
|
- **Website:** https://skillseekersweb.com/
|
|
- **PyPI:** https://pypi.org/project/skill-seekers/
|
|
- **Issues:** https://github.com/yusufkaraaslan/Skill_Seekers/issues
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](../LICENSE) file.
|
|
|
|
---
|
|
|
|
*Happy skill building! 🚀*
|