Tagasi juhtpaneelile

Dokumentatsioon

Õppige Asyntaid kasutama

GitHubi integratsioon

Vasta küsimustele Issues ja Discussions all oma dokumentatsiooni põhjal

Ühenda GitHub

Ülevaade

Asyntai GitHubi rakendus vastab küsimustele, mida inimesed sinu hoidlates esitavad. Kui keegi avab arutelu Q&A kategoorias või issue sinu küsimuse sildiga, loeb Asyntai sinu dokumentatsiooni ja postitab vastuse kommentaarina. Sinu hooldajatele jääb aega vearaportite ja koodi jaoks.

See on mõeldud projektidele, mille dokumentatsioon on Asyntais: dokumentatsioonisait, README, abikeskus või üles laaditud failid. Vastused tulevad sellest sisust, samast teadmusbaasist, mida sinu veebisaidi vestlus kasutab.

Kuidas see töötab

Rakendus vastab kolmes kohas:

  • Discussions: iga uus arutelu kategoorias, mis vastuseid vastu võtab, näiteks Q&A.
  • Issues: iga uus issue sinu valitud sildiga. Vaikimisi silt on question. Vearaportid ja funktsioonisoovid jäävad sinu meeskonnale.
  • Jätkuküsimused: igaüks võib kommentaaris mainida @asyntai-ai-agent, et rohkem küsida. Rakendus mäletab lõime, nii et jätkuküsimustest saadakse aru kontekstis.

Iga vastus põhineb sinu dokumentatsioonil. Dokumentatsioonist väljapoole jääv küsimus jääb hooldajale avatuks, nii et rakenduse iga kommentaari võib usaldada.

Nõuded

  • Asyntai konto, mille teadmusbaasis on sinu dokumentatsioon. Alustamiseks piisab tasuta paketist.
  • GitHubi hoidla isiklikul kontol või organisatsioonis, kuhu saad rakendusi paigaldada.
  • Discussions jaoks kategooria, mis vastuseid vastu võtab. GitHub nimetab seda Q&A kategooriaks.

Paigaldamine

Asyntai lisamiseks oma hoidlatesse järgi neid samme:

1

Paigalda rakendus GitHubis

Ava Asyntai rakendus GitHub Marketplace'is ja vajuta Install. Vali konto ja hoidlad, kus see vastata tohib. Hoidlaid saad hiljem GitHubi seadetes muuta.

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

Ühendage oma Asyntai konto

Paigalduse lõppedes suunab GitHub sind Asyntaisse. Logi sisse või loo tasuta konto ja vali veebisait, mille teadmusbaasist rakendus vastab. Seda tuleb teha vaid korra.

3

Vali, kus see vastab

Asyntai juhtpaneeli GitHubi lehel lülita Discussions ja Issues sisse või välja ning määra silt, mis märgib issue küsimuseks. Seaded kehtivad paigalduse igale hoidlale.

4

Esita küsimus

Ava arutelu oma Q&A kategoorias või issue küsimuse sildiga. Vastus ilmub kommentaarina minuti jooksul. Jätkuküsimuse esitamiseks maini rakendust vastuses.

Vihje: Lisa oma dokumentatsioonisait, README ja changelog teadmusbaasi oma Asyntai juhtpaneelil. Mida rohkem dokumentatsiooni rakendusel on, seda rohkematele küsimustele see vastab.

Mida rakendus oskab

  • Vastata paigaldus-, seadistus- ja kasutusküsimustele sinu dokumentatsiooni põhjal, päeval ja öösel
  • Kirjutada GitHub Markdownis, koodiplokkidega käskude ja seadistuse jaoks
  • Linkida dokumentatsioonilehele, kust vastus pärineb
  • Hoida iga lõime konteksti jätkuküsimuste jaoks
  • Vastata keeles, milles küsimus esitati
  • Jätta vearaportid, funktsioonisoovid ja pull requestid sinu meeskonnale

Õigused

Rakendus küsib lugemis- ja kirjutusõigust Issues ja Discussions jaoks, et küsimust lugeda ja vastust postitada, ning lugemisõigust hoidla metaandmetele.

Privaatsus

Asyntai saab küsimuse teksti, hoidla nime ja küsija GitHubi kasutajanime. Iga vastatud lõim salvestatakse vestlusena sinu Asyntai juhtpaneelile, nagu vestlus sinu veebisaidil.

Paketid ja hinnad

GitHubi integratsioon on saadaval kõigis Asyntai pakettides, ka tasuta paketis. Iga vastus loeb ühe sõnumina sinu kuulimiidist, mis on jagatud kõigi sinu kanalite ja integratsioonide vahel. Vaata hindu.

Eemaldamine

Ava GitHubi seaded, siis Applications, siis Installed GitHub Apps ja eemalda Asyntai. Rakendus lõpetab vastamise kohe. Võid ka Asyntai juhtpaneeli GitHubi lehel vajutada Ühenda lahti.

Vajate abi?

Kui teil on küsimusi või tekib probleeme, võtke meiega ühendust aadressil [email protected].