Integrácia GitHub

Odpovedajte na otázky v Issues a Discussions z vašej dokumentácie

Prehľad

Aplikácia Asyntai pre GitHub odpovedá na otázky, ktoré ľudia kladú vo vašich repozitároch. Keď niekto otvorí diskusiu v kategórii Q&A alebo issue s vaším štítkom pre otázky, Asyntai prečíta vašu dokumentáciu a zverejní odpoveď ako komentár. Vaši správcovia si nechajú čas na hlásenia chýb a kód.

Je určená pre projekty, ktoré majú dokumentáciu v Asyntai: dokumentačný web, README, centrum pomoci alebo nahrané súbory. Odpovede vychádzajú z tohto obsahu, z tej istej znalostnej bázy, ktorú používa chat na vašom webe.

Ako to funguje

Aplikácia odpovedá na troch miestach:

Discussions: každá nová diskusia v kategórii, ktorá prijíma odpovede, napríklad Q&A.
Issues: každé nové issue so štítkom, ktorý si zvolíte. Predvolený štítok je question. Hlásenia chýb a požiadavky na funkcie zostávajú vášmu tímu.
Doplňujúce otázky: ktokoľvek môže v komentári spomenúť @asyntai-ai-agent a opýtať sa ďalej. Aplikácia si vlákno pamätá, takže doplňujúcim otázkam rozumie v kontexte.

Každá odpoveď vychádza z vašej dokumentácie. Otázka mimo dokumentácie zostáva otvorená pre správcu, takže každému komentáru aplikácie môžete veriť.

Požiadavky

Účet Asyntai s vašou dokumentáciou v znalostnej báze. Na začiatok stačí bezplatný plán.
Repozitár na GitHube, na osobnom účte alebo v organizácii, kde môžete inštalovať aplikácie.
Pre Discussions kategória, ktorá prijíma odpovede. GitHub ju nazýva kategória Q&A.

Inštalácia

Podľa týchto krokov pridáte Asyntai do svojich repozitárov:

Nainštalujte aplikáciu na GitHube

Otvorte aplikáciu Asyntai na GitHub Marketplace a stlačte Install. Zvoľte účet a repozitáre, kde smie odpovedať. Repozitáre môžete neskôr zmeniť v nastaveniach GitHubu.

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

Prepojte svoj účet Asyntai

Po dokončení inštalácie vás GitHub presmeruje do Asyntai. Prihláste sa alebo si vytvorte bezplatný účet a zvoľte web, z ktorého znalostnej bázy má aplikácia odpovedať. Stačí to urobiť raz.

Zvoľte, kde má odpovedať

Na stránke GitHub vo vašom paneli Asyntai zapnite alebo vypnite Discussions a Issues a nastavte štítok, ktorý označuje issue ako otázku. Nastavenia platia pre každý repozitár v inštalácii.

Položte otázku

Otvorte diskusiu vo svojej kategórii Q&A alebo issue so štítkom pre otázky. Odpoveď sa objaví ako komentár do minúty. Spomeňte aplikáciu v odpovedi, ak chcete položiť doplňujúcu otázku.

Tip: Pridajte svoj dokumentačný web, README a changelog do znalostnej bázy vo svojom paneli Asyntai. Čím viac dokumentácie aplikácia má, tým viac otázok zodpovie.

Čo aplikácia dokáže

Odpovedať na otázky k inštalácii, nastaveniu a používaniu z vašej dokumentácie, vo dne v noci
Písať v GitHub Markdowne, s blokmi kódu pre príkazy a konfiguráciu
Odkazovať na stránku dokumentácie, z ktorej odpoveď pochádza
Udržiavať kontext každého vlákna pre doplňujúce otázky
Odpovedať v jazyku, v ktorom bola otázka položená
Nechať hlásenia chýb, požiadavky na funkcie a pull requesty vášmu tímu

Povolenia

Aplikácia žiada o oprávnenie na čítanie a zápis pre Issues a Discussions, aby mohla prečítať otázku a zverejniť odpoveď, a o oprávnenie na čítanie metadát repozitára.

Ochrana osobných údajov

Asyntai prijíma text otázky, názov repozitára a používateľské meno pýtajúceho sa na GitHube. Každé zodpovedané vlákno sa ukladá ako konverzácia vo vašom paneli Asyntai, rovnako ako chat na vašom webe.

Tarify a ceny

Integrácia GitHub je dostupná vo všetkých plánoch Asyntai vrátane bezplatného. Každá odpoveď sa počíta ako jedna správa z vášho mesačného limitu, ktorý zdieľate naprieč všetkými kanálmi a integráciami. Zobraziť ceny.

Odinštalovanie

Otvorte nastavenia GitHubu, potom Applications, ďalej Installed GitHub Apps a odinštalujte Asyntai. Aplikácia okamžite prestane odpovedať. Môžete tiež stlačiť Odpojiť na stránke GitHub vo svojom paneli Asyntai.

Potrebujete pomoc?

Ak máte akékoľvek otázky alebo narazíte na problémy, kontaktujte nás na [email protected].

Dokumentácia