Tilbake til dashbord

Dokumentasjon

Lær hvordan du bruker Asyntai

GitHub-integrasjon

Svar på spørsmål i Issues og Discussions ut fra dokumentasjonen din

Koble til GitHub

Oversikt

Asyntais GitHub-app svarer på spørsmålene folk stiller i repositoriene dine. Når noen åpner en Discussion i en Q&A-kategori eller et Issue med spørsmålsetiketten din, leser Asyntai dokumentasjonen og legger ut svaret som en kommentar. Vedlikeholderne dine beholder tiden sin til feilrapporter og kode.

Den er laget for prosjekter som har dokumentasjonen i Asyntai: et dokumentasjonsnettsted, en README, et hjelpesenter eller opplastede filer. Svarene kommer fra det innholdet, den samme kunnskapsbasen som nettstedschatten din bruker.

Slik fungerer det

Appen svarer tre steder:

  • Discussions: hver ny diskusjon i en kategori som godtar svar, for eksempel Q&A.
  • Issues: hvert nytt issue med etiketten du velger. Standardetiketten er question. Feilrapporter og funksjonsønsker blir hos teamet ditt.
  • Oppfølging: hvem som helst kan nevne @asyntai-ai-agent i en kommentar for å spørre mer. Appen husker tråden, så oppfølgingsspørsmål forstås i sammenheng.

Hvert svar bygger på dokumentasjonen din. Et spørsmål utenfor dokumentasjonen forblir åpent for en vedlikeholder, så hver kommentar appen skriver er til å stole på.

Krav

  • En Asyntai-konto med dokumentasjonen din i kunnskapsbasen. Gratisplanen er nok til å starte.
  • Et GitHub-repositorium, på en personlig konto eller i en organisasjon, der du kan installere apper.
  • For Discussions, en kategori som godtar svar. GitHub kaller det en Q&A-kategori.

Installasjon

Følg disse trinnene for å legge Asyntai til repositoriene dine:

1

Installer appen på GitHub

Åpne Asyntai-appen på GitHub Marketplace og trykk Install. Velg kontoen og repositoriene der den får svare. Du kan endre repositoriene senere i GitHub-innstillingene.

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

Koble til Asyntai-kontoen din

GitHub sender deg til Asyntai når installasjonen er ferdig. Logg inn, eller opprett en gratis konto, og velg nettstedet appen skal svare ut fra kunnskapsbasen til. Dette gjøres bare én gang.

3

Velg hvor den svarer

På GitHub-siden i Asyntai-dashbordet slår du Discussions og Issues på eller av og setter etiketten som markerer et issue som et spørsmål. Innstillingene gjelder for hvert repositorium i installasjonen.

4

Still et spørsmål

Åpne en diskusjon i Q&A-kategorien din, eller et issue med spørsmålsetiketten. Svaret vises som en kommentar innen et minutt. Nevn appen i et svar for å stille et oppfølgingsspørsmål.

Tips: Legg til dokumentasjonsnettstedet, README og changelog i kunnskapsbasen i Asyntai-dashbordet. Jo mer av dokumentasjonen appen har, desto flere spørsmål svarer den på.

Hva appen kan

  • Svare på spørsmål om oppsett, konfigurasjon og bruk ut fra dokumentasjonen din, dag og natt
  • Skrive GitHub Markdown, med kodeblokker for kommandoer og konfigurasjon
  • Lenke til dokumentasjonssiden svaret kommer fra
  • Beholde konteksten i hver tråd for oppfølgingsspørsmål
  • Svare på språket spørsmålet ble stilt på
  • Overlate feilrapporter, funksjonsønsker og pull requests til teamet ditt

Tillatelser

Appen ber om lese- og skrivetilgang til Issues og Discussions, for å lese spørsmålet og legge ut svaret, og lesetilgang til repositoriets metadata.

Personvern

Asyntai mottar teksten i spørsmålet, navnet på repositoriet og GitHub-brukernavnet til den som spør. Hver besvarte tråd lagres som en samtale i Asyntai-dashbordet ditt, som en chat på nettstedet ditt.

Abonnementer og priser

GitHub-integrasjonen er tilgjengelig i alle Asyntai-planer, også gratisplanen. Hvert svar teller som én melding i månedskvoten din, som deles av alle kanalene og integrasjonene dine. Se priser.

Avinstallering

Åpne GitHub-innstillingene, deretter Applications, deretter Installed GitHub Apps, og avinstaller Asyntai. Appen slutter å svare med en gang. Du kan også trykke Koble fra på GitHub-siden i Asyntai-dashbordet.

Trenger du hjelp?

Hvis du har spørsmål eller støter på problemer, kontakt oss på [email protected].