Nazaj na nadzorno ploščo

Dokumentacija

Naučite se uporabljati Asyntai

Integracija GitHub

Odgovarjajte na vprašanja v Issues in Discussions iz svoje dokumentacije

Poveži GitHub

Pregled

Aplikacija Asyntai za GitHub odgovarja na vprašanja, ki jih ljudje zastavljajo v vaših repozitorijih. Ko nekdo odpre razpravo v kategoriji Q&A ali issue z vašo oznako za vprašanje, Asyntai prebere vašo dokumentacijo in objavi odgovor kot komentar. Vaši vzdrževalci ohranijo čas za prijave napak in kodo.

Namenjena je projektom, ki imajo dokumentacijo v Asyntai: spletno mesto z dokumentacijo, README, center za pomoč ali naložene datoteke. Odgovori izhajajo iz te vsebine, iste baze znanja, ki jo uporablja klepet na vašem spletnem mestu.

Kako deluje

Aplikacija odgovarja na treh mestih:

  • Discussions: vsaka nova razprava v kategoriji, ki sprejema odgovore, na primer Q&A.
  • Issues: vsak nov issue z oznako, ki jo izberete. Privzeta oznaka je question. Prijave napak in zahteve za funkcije ostanejo vaši ekipi.
  • Dodatna vprašanja: kdor koli lahko v komentarju omeni @asyntai-ai-agent in vpraša več. Aplikacija si zapomni nit, zato dodatna vprašanja razume v kontekstu.

Vsak odgovor temelji na vaši dokumentaciji. Vprašanje zunaj dokumentacije ostane odprto za vzdrževalca, zato lahko vsakemu komentarju aplikacije zaupate.

Zahteve

  • Račun Asyntai z vašo dokumentacijo v bazi znanja. Za začetek zadostuje brezplačni paket.
  • Repozitorij GitHub, na osebnem računu ali v organizaciji, kjer lahko nameščate aplikacije.
  • Za Discussions kategorija, ki sprejema odgovore. GitHub jo imenuje kategorija Q&A.

Namestitev

Sledite tem korakom, da dodate Asyntai v svoje repozitorije:

1

Namestite aplikacijo na GitHubu

Odprite aplikacijo Asyntai na GitHub Marketplace in pritisnite Install. Izberite račun in repozitorije, kjer sme odgovarjati. Repozitorije lahko pozneje spremenite v nastavitvah GitHuba.

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

Povežite svoj račun Asyntai

GitHub vas po končani namestitvi pošlje v Asyntai. Prijavite se ali ustvarite brezplačen račun in izberite spletno mesto, iz čigar baze znanja aplikacija odgovarja. To storite samo enkrat.

3

Izberite, kje odgovarja

Na strani GitHub v nadzorni plošči Asyntai vklopite ali izklopite Discussions in Issues ter nastavite oznako, ki issue označi kot vprašanje. Nastavitve veljajo za vsak repozitorij v namestitvi.

4

Zastavite vprašanje

Odprite razpravo v svoji kategoriji Q&A ali issue z oznako za vprašanje. Odgovor se pojavi kot komentar v minuti. Omenite aplikacijo v odgovoru, da zastavite dodatno vprašanje.

Nasvet: Dodajte svoje spletno mesto z dokumentacijo, README in changelog v bazo znanja v svoji nadzorni plošči Asyntai. Več dokumentacije kot ima aplikacija, na več vprašanj odgovori.

Kaj aplikacija zmore

  • Odgovarjati na vprašanja o namestitvi, nastavitvah in uporabi iz vaše dokumentacije, podnevi in ponoči
  • Pisati v GitHub Markdown, z bloki kode za ukaze in konfiguracijo
  • Povezati na stran dokumentacije, iz katere izhaja odgovor
  • Ohranjati kontekst vsake niti za dodatna vprašanja
  • Odgovarjati v jeziku, v katerem je bilo vprašanje zastavljeno
  • Prepuščati prijave napak, zahteve za funkcije in pull requeste vaši ekipi

Dovoljenja

Aplikacija zahteva dostop za branje in pisanje v Issues in Discussions, da lahko prebere vprašanje in objavi odgovor, ter dostop za branje metapodatkov repozitorija.

Zasebnost

Asyntai prejme besedilo vprašanja, ime repozitorija in uporabniško ime GitHub osebe, ki sprašuje. Vsaka odgovorjena nit se shrani kot pogovor v vaši nadzorni plošči Asyntai, tako kot klepet na vašem spletnem mestu.

Paketi in cene

Integracija GitHub je na voljo v vseh paketih Asyntai, tudi brezplačnem. Vsak odgovor šteje kot eno sporočilo iz mesečne kvote, ki si jo delijo vsi vaši kanali in integracije. Ogled cen.

Odstranitev

Odprite nastavitve GitHuba, nato Applications, nato Installed GitHub Apps in odstranite Asyntai. Aplikacija takoj preneha odgovarjati. Lahko tudi pritisnete Prekini povezavo na strani GitHub v nadzorni plošči Asyntai.

Potrebujete pomoč?

Če imate kakršna koli vprašanja ali naletite na težave, nas kontaktirajte na [email protected].