GitHub-Integration
Beantworten Sie Fragen in Issues und Discussions aus Ihrer Dokumentation
Übersicht
Die Asyntai GitHub App beantwortet die Fragen, die Menschen in Ihren Repositories stellen. Wenn jemand eine Discussion in einer Q&A-Kategorie oder ein Issue mit Ihrem Fragen-Label eröffnet, liest Asyntai Ihre Dokumentation und veröffentlicht die Antwort als Kommentar. Ihre Maintainer behalten ihre Zeit für Fehlerberichte und Code.
Sie ist für Projekte gedacht, deren Dokumentation in Asyntai liegt: eine Dokumentationsseite, eine README, ein Hilfecenter oder hochgeladene Dateien. Die Antworten stammen aus diesen Inhalten, derselben Wissensdatenbank, die Ihr Website-Chat nutzt.
So funktioniert es
Die App antwortet an drei Stellen:
- Discussions: jede neue Discussion in einer Kategorie, die Antworten zulässt, zum Beispiel Q&A.
- Issues: jedes neue Issue mit dem Label, das Sie wählen. Das Standard-Label ist
question. Fehlerberichte und Feature-Wünsche bleiben bei Ihrem Team. - Rückfragen: jeder kann
@asyntai-ai-agentin einem Kommentar erwähnen, um weiterzufragen. Die App merkt sich den Thread, sodass Rückfragen im Kontext verstanden werden.
Jede Antwort ist in Ihrer Dokumentation verankert. Eine Frage außerhalb der Doku bleibt für einen Maintainer offen, sodass Sie jedem Kommentar der App vertrauen können.
Voraussetzungen
- Ein Asyntai-Konto mit Ihrer Dokumentation in der Wissensdatenbank. Der kostenlose Plan reicht für den Start.
- Ein GitHub-Repository, auf einem persönlichen Konto oder in einer Organisation, in dem Sie Apps installieren dürfen.
- Für Discussions eine Kategorie, die Antworten zulässt. GitHub nennt das eine Q&A-Kategorie.
Installation
Folgen Sie diesen Schritten, um Asyntai zu Ihren Repositories hinzuzufügen:
Installieren Sie die App auf GitHub
Öffnen Sie die Asyntai-App im GitHub Marketplace und klicken Sie auf Install. Wählen Sie das Konto und die Repositories, in denen sie antworten darf. Die Repositories können Sie später in Ihren GitHub-Einstellungen ändern.
https://github.com/apps/asyntai-ai-agent
Verbinden Sie Ihr Asyntai-Konto
GitHub leitet Sie nach der Installation zu Asyntai weiter. Melden Sie sich an oder erstellen Sie ein kostenloses Konto und wählen Sie die Website, aus deren Wissensdatenbank die App antwortet. Das ist nur einmal nötig.
Wählen Sie, wo sie antwortet
Auf der GitHub-Seite in Ihrem Asyntai-Dashboard schalten Sie Discussions und Issues ein oder aus und legen das Label fest, das ein Issue als Frage kennzeichnet. Die Einstellungen gelten für jedes Repository der Installation.
Stellen Sie eine Frage
Eröffnen Sie eine Discussion in Ihrer Q&A-Kategorie oder ein Issue mit dem Fragen-Label. Die Antwort erscheint innerhalb einer Minute als Kommentar. Erwähnen Sie die App in einer Antwort, um eine Rückfrage zu stellen.
Tipp: Fügen Sie Ihre Dokumentationsseite, README und Changelog in Ihrem Asyntai-Dashboard zur Wissensdatenbank hinzu. Je mehr Ihrer Doku die App hat, desto mehr Fragen beantwortet sie.
Was die App kann
- Fragen zu Einrichtung, Konfiguration und Nutzung aus Ihrer Dokumentation beantworten, Tag und Nacht
- GitHub Markdown schreiben, mit Codeblöcken für Befehle und Konfiguration
- Auf die Dokumentationsseite verlinken, aus der die Antwort stammt
- Den Kontext jedes Threads für Rückfragen behalten
- In der Sprache antworten, in der die Frage gestellt wurde
- Fehlerberichte, Feature-Wünsche und Pull Requests Ihrem Team überlassen
Berechtigungen
Die App bittet um Lese- und Schreibzugriff auf Issues und Discussions, um die Frage zu lesen und die Antwort zu veröffentlichen, sowie um Lesezugriff auf Repository-Metadaten.
Datenschutz
Asyntai erhält den Text der Frage, den Namen des Repositories und den GitHub-Benutzernamen der fragenden Person. Jeder beantwortete Thread wird als Unterhaltung in Ihrem Asyntai-Dashboard gespeichert, wie ein Chat auf Ihrer Website.
Tarife und Preise
Die GitHub-Integration ist in allen Asyntai-Plänen verfügbar, auch im kostenlosen. Jede Antwort zählt als eine Nachricht Ihres monatlichen Kontingents, das alle Ihre Kanäle und Integrationen teilen. Preise ansehen.
Deinstallation
Öffnen Sie Ihre GitHub-Einstellungen, dann Applications, dann Installed GitHub Apps, und deinstallieren Sie Asyntai. Die App hört sofort auf zu antworten. Sie können auch auf der GitHub-Seite in Ihrem Asyntai-Dashboard auf Trennen klicken.
Brauchen Sie Hilfe?
Wenn Sie Fragen haben oder auf Probleme stoßen, kontaktieren Sie uns unter [email protected].