Skip to main content

Convert documentation to AI-ready skills for coding assistants

Project description

Doc-to-Skill

Автоматический инструмент для скачивания документации и генерации AI-навыков (skills) для Code.

Возможности

  • 📥 Скачивание документации - рекурсивный краулинг сайтов с конвертацией в Markdown
  • 🔧 Генерация навыков - автоматическое создание SKILL.md для AI-ассистентов
  • 🚀 Полный пайплайн - одна команда для установки документации в проект
  • 📋 OpenAPI поддержка - парсинг Swagger/OpenAPI спецификаций

Установка

# Установка из локальной директории
pip install -e .

# Или установка зависимостей напрямую
pip install -r requirements.txt

Использование

Скачать документацию

doc-to-skill download https://docs.example.com -o ./docs/example

Сгенерировать навык

doc-to-skill generate ./docs/example --name "Example API"

Полный пайплайн (скачать + сгенерировать + установить)

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/ - готовый навык

Список установленных навыков

doc-to-skill list-skills

Структура сгенерированного навыка

.agent/skills/example-api/
├── SKILL.md        # Краткий overview для AI
├── reference.md    # Полный API справочник
└── examples.md     # Примеры кода

Пример SKILL.md

---
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doc_to_skill-0.2.0.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doc_to_skill-0.2.0-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file doc_to_skill-0.2.0.tar.gz.

File metadata

  • Download URL: doc_to_skill-0.2.0.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for doc_to_skill-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bbc0a852b3f0505dbfe1af84de22eca39408c6ef4af6e7a9acd68142119ca468
MD5 b95255a716f1f40f2ae66a5454f7fb15
BLAKE2b-256 74a6b9dad3bf68854b998045d6fc49d2c99b45d34f889e2e5f0cb9767dbd7b9f

See more details on using hashes here.

File details

Details for the file doc_to_skill-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: doc_to_skill-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for doc_to_skill-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b9a9e2168b8e711fb6301733e551ae84e66c2d8b745145af3f5f9fc461dfbd7
MD5 06f3dca0e539017026ad4f9df722a702
BLAKE2b-256 b0dce5c7646450a8e6bd00527c36e28b2365e69b5eb4ff485b1518cd161fe0bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page