Powrót do panelu

Dokumentacja

Dowiedz się, jak korzystać z Asyntai

Integracja z GitHub

Odpowiadaj na pytania w Issues i Discussions na podstawie swojej dokumentacji

Połącz GitHub

Przegląd

Aplikacja GitHub Asyntai odpowiada na pytania zadawane w Twoich repozytoriach. Gdy ktoś otworzy dyskusję w kategorii Q&A lub issue z Twoją etykietą pytania, Asyntai czyta Twoją dokumentację i publikuje odpowiedź jako komentarz. Twoi opiekunowie zachowują czas na zgłoszenia błędów i kod.

Jest przeznaczona dla projektów, które trzymają dokumentację w Asyntai: strona dokumentacji, README, centrum pomocy lub przesłane pliki. Odpowiedzi pochodzą z tej treści, z tej samej bazy wiedzy, z której korzysta czat na Twojej stronie.

Jak to działa

Aplikacja odpowiada w trzech miejscach:

  • Discussions: każda nowa dyskusja w kategorii, która przyjmuje odpowiedzi, na przykład Q&A.
  • Issues: każde nowe issue z etykietą, którą wybierzesz. Domyślna etykieta to question. Zgłoszenia błędów i prośby o funkcje zostają przy Twoim zespole.
  • Pytania dodatkowe: każdy może wspomnieć @asyntai-ai-agent w komentarzu, aby zapytać o więcej. Aplikacja pamięta wątek, więc pytania dodatkowe są rozumiane w kontekście.

Każda odpowiedź opiera się na Twojej dokumentacji. Pytanie spoza dokumentacji pozostaje otwarte dla opiekuna, więc każdemu komentarzowi aplikacji możesz zaufać.

Wymagania

  • Konto Asyntai z Twoją dokumentacją w bazie wiedzy. Na początek wystarczy plan bezpłatny.
  • Repozytorium GitHub, na koncie osobistym lub w organizacji, w którym możesz instalować aplikacje.
  • Dla Discussions kategoria, która przyjmuje odpowiedzi. GitHub nazywa ją kategorią Q&A.

Instalacja

Wykonaj te kroki, aby dodać Asyntai do swoich repozytoriów:

1

Zainstaluj aplikację na GitHub

Otwórz aplikację Asyntai w GitHub Marketplace i naciśnij Install. Wybierz konto i repozytoria, w których może odpowiadać. Repozytoria możesz później zmienić w ustawieniach GitHub.

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

Połącz swoje konto Asyntai

Po zakończeniu instalacji GitHub przekieruje Cię do Asyntai. Zaloguj się lub utwórz bezpłatne konto i wybierz stronę, z której bazy wiedzy aplikacja ma odpowiadać. Wystarczy zrobić to raz.

3

Wybierz, gdzie odpowiada

Na stronie GitHub w panelu Asyntai włącz lub wyłącz Discussions i Issues oraz ustaw etykietę, która oznacza issue jako pytanie. Ustawienia obowiązują w każdym repozytorium instalacji.

4

Zadaj pytanie

Otwórz dyskusję w swojej kategorii Q&A lub issue z etykietą pytania. Odpowiedź pojawi się jako komentarz w ciągu minuty. Wspomnij aplikację w odpowiedzi, aby zadać pytanie dodatkowe.

Wskazówka: Dodaj stronę dokumentacji, README i changelog do bazy wiedzy w swoim panelu Asyntai. Im więcej dokumentacji ma aplikacja, tym więcej pytań odpowiada.

Co potrafi aplikacja

  • Odpowiadać na pytania o instalację, konfigurację i użytkowanie na podstawie Twojej dokumentacji, dzień i noc
  • Pisać w GitHub Markdown, z blokami kodu dla poleceń i konfiguracji
  • Podawać link do strony dokumentacji, z której pochodzi odpowiedź
  • Zachowywać kontekst każdego wątku dla pytań dodatkowych
  • Odpowiadać w języku, w którym zadano pytanie
  • Zostawiać zgłoszenia błędów, prośby o funkcje i pull requesty Twojemu zespołowi

Uprawnienia

Aplikacja prosi o dostęp do odczytu i zapisu Issues i Discussions, aby odczytać pytanie i opublikować odpowiedź, oraz o dostęp do odczytu metadanych repozytorium.

Prywatność

Asyntai otrzymuje treść pytania, nazwę repozytorium i nazwę użytkownika GitHub osoby pytającej. Każdy wątek z odpowiedzią jest zapisywany jako rozmowa w Twoim panelu Asyntai, jak czat na Twojej stronie.

Plany i ceny

Integracja z GitHub jest dostępna we wszystkich planach Asyntai, także w bezpłatnym. Każda odpowiedź liczy się jako jedna wiadomość z miesięcznego limitu, wspólnego dla wszystkich kanałów i integracji. Zobacz cennik.

Odinstalowanie

Otwórz ustawienia GitHub, potem Applications, potem Installed GitHub Apps i odinstaluj Asyntai. Aplikacja natychmiast przestaje odpowiadać. Możesz też nacisnąć Rozłącz na stronie GitHub w panelu Asyntai.

Potrzebujesz pomocy?

Jeśli masz pytania lub napotkasz problemy, skontaktuj się z nami pod adresem [email protected].