Grįžti į valdymo skydą

Dokumentacija

Sužinokite, kaip naudoti Asyntai

„GitHub“ integracija

Atsakykite į klausimus „Issues“ ir „Discussions“ skiltyse pagal savo dokumentaciją

Prijungti „GitHub“

Apžvalga

„Asyntai“ „GitHub“ programa atsako į klausimus, kuriuos žmonės užduoda jūsų saugyklose. Kai kas nors atidaro diskusiją Q&A kategorijoje arba „issue“ su jūsų klausimo žyma, „Asyntai“ perskaito jūsų dokumentaciją ir paskelbia atsakymą kaip komentarą. Jūsų prižiūrėtojai pasilieka laiko klaidų pranešimams ir kodui.

Ji skirta projektams, kurių dokumentacija yra „Asyntai“: dokumentacijos svetainė, README, pagalbos centras ar įkelti failai. Atsakymai kyla iš šio turinio, tos pačios žinių bazės, kurią naudoja jūsų svetainės pokalbis.

Kaip tai veikia

Programa atsako trijose vietose:

  • Discussions: kiekviena nauja diskusija kategorijoje, kuri priima atsakymus, pavyzdžiui, Q&A.
  • Issues: kiekvienas naujas „issue“ su jūsų pasirinkta žyma. Numatytoji žyma yra question. Klaidų pranešimai ir funkcijų prašymai lieka jūsų komandai.
  • Papildomi klausimai: bet kas gali komentare paminėti @asyntai-ai-agent, kad paklaustų daugiau. Programa prisimena giją, todėl papildomi klausimai suprantami kontekste.

Kiekvienas atsakymas remiasi jūsų dokumentacija. Klausimas už dokumentacijos ribų lieka atviras prižiūrėtojui, todėl kiekvienu programos komentaru galima pasitikėti.

Reikalavimai

  • „Asyntai“ paskyra su jūsų dokumentacija žinių bazėje. Pradžiai užtenka nemokamo plano.
  • „GitHub“ saugykla asmeninėje paskyroje arba organizacijoje, kur galite diegti programas.
  • „Discussions“ skilčiai – kategorija, kuri priima atsakymus. „GitHub“ ją vadina Q&A kategorija.

Įdiegimas

Atlikite šiuos veiksmus, kad pridėtumėte „Asyntai“ prie savo saugyklų:

1

Įdiekite programą „GitHub“

Atidarykite „Asyntai“ programą „GitHub Marketplace“ ir paspauskite „Install“. Pasirinkite paskyrą ir saugyklas, kuriose ji gali atsakyti. Saugyklas vėliau galite pakeisti „GitHub“ nustatymuose.

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

Prijunkite savo „Asyntai“ paskyrą

Baigus diegimą „GitHub“ nukreipia jus į „Asyntai“. Prisijunkite arba susikurkite nemokamą paskyrą ir pasirinkite svetainę, iš kurios žinių bazės programa atsako. Tai daroma tik vieną kartą.

3

Pasirinkite, kur ji atsako

„Asyntai“ valdymo skydelio „GitHub“ puslapyje įjunkite arba išjunkite „Discussions“ ir „Issues“ bei nustatykite žymą, kuri pažymi „issue“ kaip klausimą. Nustatymai galioja kiekvienai diegimo saugyklai.

4

Užduokite klausimą

Atidarykite diskusiją savo Q&A kategorijoje arba „issue“ su klausimo žyma. Atsakymas pasirodo kaip komentaras per minutę. Paminėkite programą atsakyme, kad užduotumėte papildomą klausimą.

Patarimas: Pridėkite savo dokumentacijos svetainę, README ir changelog į žinių bazę savo „Asyntai“ valdymo skydelyje. Kuo daugiau dokumentacijos programa turi, tuo į daugiau klausimų ji atsako.

Ką programa gali

  • Atsakyti į diegimo, konfigūravimo ir naudojimo klausimus pagal jūsų dokumentaciją dieną ir naktį
  • Rašyti „GitHub Markdown“ su kodo blokais komandoms ir konfigūracijai
  • Pateikti nuorodą į dokumentacijos puslapį, iš kurio kilo atsakymas
  • Išlaikyti kiekvienos gijos kontekstą papildomiems klausimams
  • Atsakyti ta kalba, kuria buvo užduotas klausimas
  • Palikti klaidų pranešimus, funkcijų prašymus ir „pull request“ jūsų komandai

Leidimai

Programa prašo skaitymo ir rašymo prieigos prie „Issues“ ir „Discussions“, kad galėtų perskaityti klausimą ir paskelbti atsakymą, bei skaitymo prieigos prie saugyklos metaduomenų.

Privatumas

„Asyntai“ gauna klausimo tekstą, saugyklos pavadinimą ir klausiančiojo „GitHub“ naudotojo vardą. Kiekviena atsakyta gija saugoma kaip pokalbis jūsų „Asyntai“ valdymo skydelyje, kaip pokalbis jūsų svetainėje.

Planai ir kainos

„GitHub“ integracija prieinama visuose „Asyntai“ planuose, įskaitant nemokamą. Kiekvienas atsakymas skaičiuojamas kaip viena žinutė iš mėnesio limito, bendro visiems jūsų kanalams ir integracijoms. Peržiūrėti kainas.

Išdiegimas

Atidarykite „GitHub“ nustatymus, tada „Applications“, tada „Installed GitHub Apps“ ir pašalinkite „Asyntai“. Programa iš karto nustoja atsakyti. Taip pat galite paspausti „Atjungti“ „Asyntai“ valdymo skydelio „GitHub“ puslapyje.

Reikia pagalbos?

Jei turite klausimų arba kilo problemų, susisiekite su mumis adresu [email protected].