Integrace GitHub

Odpovídejte na otázky v Issues a Discussions z vaší dokumentace

Přehled

Aplikace Asyntai pro GitHub odpovídá na otázky, které lidé pokládají ve vašich repozitářích. Když někdo otevře diskusi v kategorii Q&A nebo issue s vaším štítkem pro otázky, Asyntai přečte vaši dokumentaci a zveřejní odpověď jako komentář. Vaši správci si nechají čas na hlášení chyb a kód.

Je určena pro projekty, které mají dokumentaci v Asyntai: dokumentační web, README, centrum nápovědy nebo nahrané soubory. Odpovědi vycházejí z tohoto obsahu, ze stejné znalostní báze, kterou používá chat na vašem webu.

Jak to funguje

Aplikace odpovídá na třech místech:

Discussions: každá nová diskuse v kategorii, která přijímá odpovědi, například Q&A.
Issues: každé nové issue se štítkem, který si zvolíte. Výchozí štítek je question. Hlášení chyb a požadavky na funkce zůstávají vašemu týmu.
Doplňující otázky: kdokoli může v komentáři zmínit @asyntai-ai-agent a zeptat se dál. Aplikace si vlákno pamatuje, takže doplňujícím otázkám rozumí v kontextu.

Každá odpověď vychází z vaší dokumentace. Otázka mimo dokumentaci zůstává otevřená pro správce, takže každému komentáři aplikace můžete věřit.

Požadavky

Účet Asyntai s vaší dokumentací ve znalostní bázi. Pro začátek stačí bezplatný plán.
Repozitář na GitHubu, na osobním účtu nebo v organizaci, kde můžete instalovat aplikace.
Pro Discussions kategorie, která přijímá odpovědi. GitHub ji nazývá kategorie Q&A.

Instalace

Podle těchto kroků přidáte Asyntai do svých repozitářů:

Nainstalujte aplikaci na GitHubu

Otevřete aplikaci Asyntai na GitHub Marketplace a stiskněte Install. Zvolte účet a repozitáře, kde smí odpovídat. Repozitáře můžete později změnit v nastavení GitHubu.

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

Propojte svůj účet Asyntai

Po dokončení instalace vás GitHub přesměruje do Asyntai. Přihlaste se nebo si vytvořte bezplatný účet a zvolte web, z jehož znalostní báze má aplikace odpovídat. Stačí to udělat jednou.

Zvolte, kde má odpovídat

Na stránce GitHub ve vašem panelu Asyntai zapněte nebo vypněte Discussions a Issues a nastavte štítek, který označuje issue jako otázku. Nastavení platí pro každý repozitář v instalaci.

Položte otázku

Otevřete diskusi ve své kategorii Q&A nebo issue se štítkem pro otázky. Odpověď se objeví jako komentář do minuty. Zmiňte aplikaci v odpovědi, pokud chcete položit doplňující otázku.

Tip: Přidejte svůj dokumentační web, README a changelog do znalostní báze ve svém panelu Asyntai. Čím více dokumentace aplikace má, tím více otázek zodpoví.

Co aplikace umí

Odpovídat na otázky k instalaci, nastavení a používání z vaší dokumentace, ve dne v noci
Psát v GitHub Markdownu, s bloky kódu pro příkazy a konfiguraci
Odkazovat na stránku dokumentace, ze které odpověď pochází
Udržovat kontext každého vlákna pro doplňující otázky
Odpovídat v jazyce, ve kterém byla otázka položena
Nechat hlášení chyb, požadavky na funkce a pull requesty vašemu týmu

Oprávnění

Aplikace žádá o oprávnění ke čtení a zápisu pro Issues a Discussions, aby mohla přečíst otázku a zveřejnit odpověď, a o oprávnění ke čtení metadat repozitáře.

Ochrana osobních údajů

Asyntai přijímá text otázky, název repozitáře a uživatelské jméno tazatele na GitHubu. Každé zodpovězené vlákno se ukládá jako konverzace ve vašem panelu Asyntai, stejně jako chat na vašem webu.

Tarify a ceny

Integrace GitHub je dostupná ve všech plánech Asyntai včetně bezplatného. Každá odpověď se počítá jako jedna zpráva z vašeho měsíčního limitu, který sdílíte napříč všemi kanály a integracemi. Zobrazit ceník.

Odinstalování

Otevřete nastavení GitHubu, poté Applications, dále Installed GitHub Apps a odinstalujte Asyntai. Aplikace okamžitě přestane odpovídat. Můžete také stisknout Odpojit na stránce GitHub ve svém panelu Asyntai.

Potřebujete pomoc?

Máte-li jakékoli dotazy nebo narazíte na problémy, kontaktujte nás na [email protected].

Dokumentace