semvec/pypi-packages huggingface dataset:
doc-to-skill 0.2.0
Convert documentation to AI-ready skills for coding assistants
License: MIT
Requires Python: >=3.10
Keywords: documentation, ai, skills, crawler, markdown

# Doc-to-Skill

Автоматический инструмент для скачивания документации и генерации AI-навыков (skills) для Code.

## Возможности

- 📥 **Скачивание документации** - рекурсивный краулинг сайтов с конвертацией в Markdown
- 🔧 **Генерация навыков** - автоматическое создание SKILL.md для AI-ассистентов
- 🚀 **Полный пайплайн** - одна команда для установки документации в проект
- 📋 **OpenAPI поддержка** - парсинг Swagger/OpenAPI спецификаций

## Установка

```bash
# Установка из локальной директории
pip install -e .

# Или установка зависимостей напрямую
pip install -r requirements.txt
```

## Использование

### Скачать документацию

```bash
doc-to-skill download https://docs.example.com -o ./docs/example
```

### Сгенерировать навык

```bash
doc-to-skill generate ./docs/example --name "Example API"
```

### Полный пайплайн (скачать + сгенерировать + установить)

```bash
doc-to-skill install https://docs.example.com ./my-project --name "Example API"
```

Это создаст:
- `./my-project/docs/api/example-api/` - скачанная документация
- `./my-project/.agent/skills/example-api/` - готовый навык

### Список установленных навыков

```bash
doc-to-skill list-skills
```

## Структура сгенерированного навыка

```
.agent/skills/example-api/
├── SKILL.md        # Краткий overview для AI
├── reference.md    # Полный API справочник
└── examples.md     # Примеры кода
```

## Пример SKILL.md

```markdown
---
name: Example API
description: API documentation and reference for Example API
---

# Example API Documentation

## When to Use This Skill

Use this skill when you need to:
- Work with Example API integration
- Implement authentication for Example API
- Find API endpoints and their parameters

## Quick Reference

### Documentation Paths

- **Full Reference**: reference.md
- **Code Examples**: examples.md
- **Raw Documentation**: docs/api/example-api/

### Common Endpoints

- **GET** `/api/users` - Get all users
- **POST** `/api/users` - Create user
...
```

## Опции команд

### download

| Опция | Описание | По умолчанию |
|-------|----------|--------------|
| `-o, --output-dir` | Директория для сохранения | `./docs` |
| `-d, --max-depth` | Максимальная глубина обхода | `3` |
| `-l, --limit` | Максимум страниц | `100` |

### generate

| Опция | Описание | По умолчанию |
|-------|----------|--------------|
| `-n, --name` | Имя сервиса/API (обязательно) | - |
| `-o, --output-dir` | Директория для навыка | `.agent/skills/<name>` |

### install

| Опция | Описание | По умолчанию |
|-------|----------|--------------|
| `-n, --name` | Имя сервиса/API (обязательно) | - |
| `-d, --max-depth` | Максимальная глубина обхода | `3` |
| `-l, --limit` | Максимум страниц | `100` |

## Лицензия

MIT