Інтеграція з GitHub

Відповідайте на запитання в Issues і Discussions на основі вашої документації

Огляд

Застосунок Asyntai для GitHub відповідає на запитання, які люди ставлять у ваших репозиторіях. Коли хтось відкриває обговорення в категорії Q&A або issue з вашою міткою запитання, Asyntai читає вашу документацію та публікує відповідь коментарем. Ваші мейнтейнери зберігають час для звітів про помилки та коду.

Він створений для проєктів, документація яких зберігається в Asyntai: сайт документації, README, центр допомоги або завантажені файли. Відповіді беруться з цього вмісту, тієї самої бази знань, яку використовує чат на вашому сайті.

Як це працює

Застосунок відповідає у трьох місцях:

Discussions: кожне нове обговорення в категорії, яка приймає відповіді, наприклад Q&A.
Issues: кожен новий issue з міткою, яку ви оберете. Мітка за замовчуванням: question. Звіти про помилки та запити функцій залишаються вашій команді.
Уточнення: будь-хто може згадати @asyntai-ai-agent у коментарі, щоб запитати більше. Застосунок пам'ятає гілку, тому уточнювальні запитання розуміються в контексті.

Кожна відповідь спирається на вашу документацію. Запитання поза документацією залишається відкритим для мейнтейнера, тому кожному коментарю застосунку можна довіряти.

Вимоги

Обліковий запис Asyntai з вашою документацією в базі знань. Для початку достатньо безкоштовного плану.
Репозиторій GitHub, на особистому обліковому записі або в організації, де ви можете встановлювати застосунки.
Для Discussions — категорія, що приймає відповіді. У GitHub вона називається категорією Q&A.

Встановлення

Виконайте ці кроки, щоб додати Asyntai до своїх репозиторіїв:

Встановіть застосунок на GitHub

Відкрийте застосунок Asyntai у GitHub Marketplace і натисніть Install. Оберіть обліковий запис і репозиторії, де він може відповідати. Репозиторії можна змінити пізніше в налаштуваннях GitHub.

https://github.com/apps/asyntai-ai-agent

Підключіть свій обліковий запис Asyntai

Після встановлення GitHub спрямує вас до Asyntai. Увійдіть або створіть безкоштовний обліковий запис і оберіть сайт, з чиєї бази знань застосунок відповідатиме. Це потрібно зробити один раз.

Оберіть, де він відповідає

На сторінці GitHub у панелі Asyntai увімкніть або вимкніть Discussions та Issues і задайте мітку, яка позначає issue як запитання. Налаштування діють для кожного репозиторію встановлення.

Поставте запитання

Відкрийте обговорення у категорії Q&A або issue з міткою запитання. Відповідь з'явиться коментарем протягом хвилини. Згадайте застосунок у відповіді, щоб поставити уточнювальне запитання.

Порада: Додайте сайт документації, README і changelog до бази знань у своїй панелі Asyntai. Що більше документації має застосунок, то більше запитань він відповідає.

Що вміє застосунок

Відповідати на запитання про встановлення, налаштування та використання на основі вашої документації, вдень і вночі
Писати в GitHub Markdown, з блоками коду для команд і конфігурації
Давати посилання на сторінку документації, з якої взято відповідь
Зберігати контекст кожної гілки для уточнювальних запитань
Відповідати мовою, якою поставлено запитання
Залишати звіти про помилки, запити функцій і pull request вашій команді

Дозволи

Застосунок запитує доступ на читання та запис до Issues і Discussions, щоб читати запитання й публікувати відповідь, і доступ на читання метаданих репозиторію.

Конфіденційність

Asyntai отримує текст запитання, назву репозиторію та ім'я користувача GitHub того, хто запитує. Кожна гілка з відповіддю зберігається як розмова у вашій панелі Asyntai, як чат на вашому сайті.

Тарифи та ціни

Інтеграція з GitHub доступна в усіх планах Asyntai, зокрема безкоштовному. Кожна відповідь рахується як одне повідомлення з місячного ліміту, спільного для всіх каналів та інтеграцій. Переглянути ціни.

Видалення

Відкрийте налаштування GitHub, потім Applications, потім Installed GitHub Apps і видаліть Asyntai. Застосунок одразу перестане відповідати. Також можна натиснути Відключити на сторінці GitHub у панелі Asyntai.

Потрібна допомога?

Якщо у вас є запитання або виникли проблеми, зв'яжiться з нами за адресою [email protected].

Документація