Terug naar dashboard

Documentatie

Leer hoe u Asyntai kunt gebruiken

GitHub-integratie

Beantwoord vragen in Issues en Discussions vanuit je documentatie

GitHub koppelen

Overzicht

De Asyntai GitHub App beantwoordt de vragen die mensen in je repositories stellen. Wanneer iemand een Discussion opent in een Q&A-categorie, of een Issue met je vraaglabel, leest Asyntai je documentatie en plaatst het antwoord als reactie. Je maintainers houden hun tijd voor bugrapporten en code.

De app is bedoeld voor projecten die hun documentatie in Asyntai hebben: een documentatiesite, een README, een helpcentrum of geüploade bestanden. De antwoorden komen uit die inhoud, dezelfde kennisbank die je websitechat gebruikt.

Hoe het werkt

De app antwoordt op drie plekken:

  • Discussions: elke nieuwe discussie in een categorie die antwoorden toestaat, zoals Q&A.
  • Issues: elke nieuwe issue met het label dat je kiest. Het standaardlabel is question. Bugrapporten en featureverzoeken blijven bij je team.
  • Vervolgvragen: iedereen kan @asyntai-ai-agent in een reactie noemen om verder te vragen. De app onthoudt de thread, dus vervolgvragen worden in context begrepen.

Elk antwoord is gebaseerd op je documentatie. Een vraag buiten de documentatie blijft open voor een maintainer, dus elke reactie van de app is er een die je kunt vertrouwen.

Vereisten

  • Een Asyntai-account met je documentatie in de kennisbank. Het gratis plan is genoeg om te beginnen.
  • Een GitHub-repository, op een persoonlijk account of in een organisatie, waar je apps mag installeren.
  • Voor Discussions een categorie die antwoorden toestaat. GitHub noemt dit een Q&A-categorie.

Installatie

Volg deze stappen om Asyntai aan je repositories toe te voegen:

1

Installeer de app op GitHub

Open de Asyntai-app op de GitHub Marketplace en klik op Install. Kies het account en de repositories waar de app mag antwoorden. Je kunt de repositories later wijzigen in je GitHub-instellingen.

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

Koppel uw Asyntai-account

GitHub stuurt je naar Asyntai zodra de installatie klaar is. Meld je aan, of maak een gratis account, en kies de website uit wiens kennisbank de app antwoordt. Dit hoeft maar één keer.

3

Kies waar de app antwoordt

Op de GitHub-pagina in je Asyntai-dashboard zet je Discussions en Issues aan of uit en stel je het label in dat een issue als vraag markeert. De instellingen gelden voor elke repository in de installatie.

4

Stel een vraag

Open een discussie in je Q&A-categorie, of een issue met het vraaglabel. Het antwoord verschijnt binnen een minuut als reactie. Noem de app in een reactie om een vervolgvraag te stellen.

Tip: Voeg je documentatiesite, README en changelog toe aan de kennisbank in je Asyntai-dashboard. Hoe meer documentatie de app heeft, hoe meer vragen hij beantwoordt.

Wat de app kan

  • Vragen over installatie, configuratie en gebruik beantwoorden vanuit je documentatie, dag en nacht
  • GitHub Markdown schrijven, met codeblokken voor commando's en configuratie
  • Linken naar de documentatiepagina waar het antwoord vandaan komt
  • De context van elke thread bewaren voor vervolgvragen
  • Antwoorden in de taal waarin de vraag is gesteld
  • Bugrapporten, featureverzoeken en pull requests aan je team overlaten

Machtigingen

De app vraagt lees- en schrijftoegang tot Issues en Discussions, om de vraag te lezen en het antwoord te plaatsen, en leestoegang tot repository-metadata.

Privacy

Asyntai ontvangt de tekst van de vraag, de naam van de repository en de GitHub-gebruikersnaam van de vraagsteller. Elke beantwoorde thread wordt als gesprek opgeslagen in je Asyntai-dashboard, net als een chat op je website.

Abonnementen en prijzen

De GitHub-integratie is beschikbaar in alle Asyntai-plannen, ook het gratis plan. Elk antwoord telt als één bericht van je maandelijkse tegoed, gedeeld door al je kanalen en integraties. Prijzen bekijken.

Verwijderen

Open je GitHub-instellingen, dan Applications, dan Installed GitHub Apps, en verwijder Asyntai. De app stopt meteen met antwoorden. Je kunt ook op Ontkoppelen klikken op de GitHub-pagina in je Asyntai-dashboard.

Hulp nodig?

Als u vragen heeft of problemen ondervindt, neem dan contact met ons op via [email protected].