docs: add llms.txt support documentation

This commit is contained in:
Edgar I.
2025-10-24 13:38:35 +04:00
parent 12424e390c
commit 0b6c2ed593
3 changed files with 26 additions and 2 deletions

View File

@@ -8,6 +8,8 @@
pip3 install requests beautifulsoup4
```
> **Note:** Skill_Seekers automatically checks for llms.txt files first, which is 10x faster when available.
### Step 2: Run the Tool
**Option A: Use a Preset (Easiest)**

View File

@@ -6,7 +6,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![MCP Integration](https://img.shields.io/badge/MCP-Integrated-blue.svg)](https://modelcontextprotocol.io)
[![Tested](https://img.shields.io/badge/Tests-142%20Passing-brightgreen.svg)](tests/)
[![Tested](https://img.shields.io/badge/Tests-207%20Passing-brightgreen.svg)](tests/)
[![Project Board](https://img.shields.io/badge/Project-Board-purple.svg)](https://github.com/users/yusufkaraaslan/projects/2)
**Automatically convert any documentation website into a Claude AI skill in minutes.**
@@ -34,6 +34,7 @@ Skill Seeker is an automated tool that transforms any documentation website into
## Key Features
### 🌐 Documentation Scraping
-**llms.txt Support** - Automatically detects and uses LLM-ready documentation files (10x faster)
-**Universal Scraper** - Works with ANY documentation website
-**Smart Categorization** - Automatically organizes content by topic
-**Code Language Detection** - Recognizes Python, JavaScript, C++, GDScript, etc.
@@ -60,7 +61,7 @@ Skill Seeker is an automated tool that transforms any documentation website into
-**Caching System** - Scrape once, rebuild instantly
### ✅ Quality Assurance
-**Fully Tested** - 142 tests with 100% pass rate
-**Fully Tested** - 207 tests with 100% pass rate
## Quick Example
@@ -139,6 +140,7 @@ graph LR
G --> H[Upload to Claude AI]
```
0. **Detect llms.txt** - Checks for llms-full.txt, llms.txt, llms-small.txt first
1. **Scrape**: Extracts all pages from documentation
2. **Categorize**: Organizes content into topics (API, guides, tutorials, etc.)
3. **Enhance**: AI analyzes docs and creates comprehensive SKILL.md with examples

View File

@@ -344,3 +344,23 @@ cat output/godot/SKILL.md # Should have real code examples
cat output/godot/references/index.md # Should show categories
ls output/godot/references/ # Should have category .md files
```
## llms.txt Support
Skill_Seekers automatically detects llms.txt files before HTML scraping:
### Detection Order
1. `{base_url}/llms-full.txt` (complete documentation)
2. `{base_url}/llms.txt` (standard version)
3. `{base_url}/llms-small.txt` (quick reference)
### Benefits
- ⚡ 10x faster (< 5 seconds vs 20-60 seconds)
- ✅ More reliable (maintained by docs authors)
- 🎯 Better quality (pre-formatted for LLMs)
- 🚫 No rate limiting needed
### Example Sites
- Hono: https://hono.dev/llms-full.txt
If no llms.txt is found, automatically falls back to HTML scraping.