wehub-resource-sync
e940d071f0
Automated Testing / Code Quality (Lint & Format) (push) Has been cancelled
Automated Testing / Security Scan (push) Has been cancelled
Automated Testing / Type Checking (push) Has been cancelled
Automated Testing / Build EPUB Artifact (push) Has been cancelled
Automated Testing / Test Summary (push) Has been cancelled
Automated Testing / Unit Tests (Python 3.11) (push) Has been cancelled
Automated Testing / Unit Tests (Python 3.10) (push) Has been cancelled
Automated Testing / Unit Tests (Python 3.12) (push) Has been cancelled
Documentation Checks / Summary (push) Has been cancelled
Documentation Checks / Cross-reference Check (push) Has been cancelled
Documentation Checks / Check Links (push) Successful in 8m28s
Documentation Checks / Mermaid Syntax (push) Failing after 5m21s
Deploy Website to GitHub Pages / Deploy to GitHub Pages (push) Has been cancelled
Deploy Website to GitHub Pages / Build static site (push) Has been cancelled
Documentation Checks / Markdown Linting (push) Has been cancelled
Плагін Documentation
Комплексна генерація та підтримка документації для вашого проєкту.
Функції
✅ Генерація API-документації ✅ Створення та оновлення README ✅ Синхронізація документації ✅ Покращення коментарів коду ✅ Генерація прикладів
Встановлення
/plugin install documentation
Що включено
Слеш-команди
/generate-api-docs— Генерація API-документації/generate-readme— Створення або оновлення README/sync-docs— Синхронізація документації зі змінами коду/validate-docs— Валідація документації
Субагенти
api-documenter— Спеціаліст з API-документаціїcode-commentator— Покращення коментарів кодуexample-generator— Створення прикладів коду
Шаблони
api-endpoint.md— Шаблон документації ендпоінту APIfunction-docs.md— Шаблон документації функціїadr-template.md— Шаблон Architecture Decision Record
MCP-сервери
- Інтеграція з GitHub для синхронізації документації
Використання
Генерація API-документації
/generate-api-docs
Створення README
/generate-readme
Синхронізація документації
/sync-docs
Валідація документації
/validate-docs
Вимоги
- Claude Code 1.0+
- Доступ до GitHub (опціонально)
Приклад робочого процесу
User: /generate-api-docs
Claude:
1. Сканує всі API-ендпоінти в /src/api/
2. Делегує субагенту api-documenter
3. Витягує сигнатури функцій та JSDoc
4. Організує за модулями/ендпоінтами
5. Використовує шаблон api-endpoint.md
6. Генерує комплексну markdown-документацію
7. Включає приклади curl, JavaScript та Python
Результат:
✅ API-документація згенерована
📄 Створені файли:
- docs/api/users.md
- docs/api/auth.md
- docs/api/products.md
📊 Покриття: 23/23 ендпоінти задокументовано
Використання шаблонів
Шаблон ендпоінту API
Використовуйте для документування REST API ендпоінтів з повними прикладами.
Шаблон документації функції
Використовуйте для документування окремих функцій/методів.
Шаблон ADR
Використовуйте для документування архітектурних рішень.
Конфігурація
Налаштуйте GitHub-токен для синхронізації документації:
export GITHUB_TOKEN="your_github_token"
Найкращі практики
- Тримайте документацію близько до коду
- Оновлюйте документацію разом зі змінами коду
- Включайте практичні приклади
- Регулярно валідуйте
- Використовуйте шаблони для консистентності