Retour au tableau de bord

Documentation

Apprenez à utiliser Asyntai

Intégration GitHub

Répondez aux questions dans les Issues et Discussions à partir de votre documentation

Connecter GitHub

Aperçu

L'application GitHub Asyntai répond aux questions que les gens posent dans vos dépôts. Quand quelqu'un ouvre une Discussion dans une catégorie Q&A, ou une Issue portant votre étiquette de question, Asyntai lit votre documentation et publie la réponse en commentaire. Vos mainteneurs gardent leur temps pour les rapports de bugs et le code.

Elle est conçue pour les projets dont la documentation est dans Asyntai : un site de documentation, un README, un centre d'aide ou des fichiers importés. Les réponses viennent de ce contenu, la même base de connaissances que celle de votre chat de site web.

Comment ça marche

L'application répond à trois endroits :

  • Discussions : chaque nouvelle discussion dans une catégorie qui accepte des réponses, comme Q&A.
  • Issues : chaque nouvelle issue portant l'étiquette que vous choisissez. L'étiquette par défaut est question. Les rapports de bugs et les demandes de fonctionnalités restent à votre équipe.
  • Relances : n'importe qui peut mentionner @asyntai-ai-agent dans un commentaire pour en demander plus. L'application se souvient du fil, donc les questions de suivi sont comprises dans leur contexte.

Chaque réponse s'appuie sur votre documentation. Une question hors de la documentation reste ouverte pour un mainteneur, donc chaque commentaire de l'application est fiable.

Prérequis

  • Un compte Asyntai avec votre documentation dans la base de connaissances. Le plan gratuit suffit pour commencer.
  • Un dépôt GitHub, sur un compte personnel ou dans une organisation, où vous pouvez installer des applications.
  • Pour les Discussions, une catégorie qui accepte des réponses. GitHub l'appelle une catégorie Q&A.

Installation

Suivez ces étapes pour ajouter Asyntai à vos dépôts :

1

Installez l'application sur GitHub

Ouvrez l'application Asyntai sur le GitHub Marketplace et cliquez sur Install. Choisissez le compte et les dépôts où elle peut répondre. Vous pourrez modifier les dépôts plus tard dans vos paramètres GitHub.

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

Connectez votre compte Asyntai

GitHub vous envoie vers Asyntai à la fin de l'installation. Connectez-vous, ou créez un compte gratuit, et choisissez le site web dont la base de connaissances sert aux réponses. C'est à faire une seule fois.

3

Choisissez où elle répond

Sur la page GitHub de votre tableau de bord Asyntai, activez ou désactivez Discussions et Issues, et définissez l'étiquette qui marque une issue comme question. Les réglages s'appliquent à chaque dépôt de l'installation.

4

Posez une question

Ouvrez une discussion dans votre catégorie Q&A, ou une issue avec l'étiquette de question. La réponse apparaît en commentaire en moins d'une minute. Mentionnez l'application dans une réponse pour poser une question de suivi.

Astuce : Ajoutez votre site de documentation, votre README et votre changelog à la base de connaissances dans votre tableau de bord Asyntai. Plus l'application dispose de documentation, plus elle répond de questions.

Ce que l'application sait faire

  • Répondre aux questions d'installation, de configuration et d'utilisation à partir de votre documentation, jour et nuit
  • Écrire en GitHub Markdown, avec des blocs de code pour les commandes et la configuration
  • Renvoyer vers la page de documentation d'où vient la réponse
  • Garder le contexte de chaque fil pour les questions de suivi
  • Répondre dans la langue de la question
  • Laisser les rapports de bugs, les demandes de fonctionnalités et les pull requests à votre équipe

Autorisations

L'application demande un accès en lecture et écriture aux Issues et Discussions, pour lire la question et publier la réponse, et un accès en lecture aux métadonnées du dépôt.

Confidentialité

Asyntai reçoit le texte de la question, le nom du dépôt et le nom d'utilisateur GitHub de la personne qui demande. Chaque fil répondu est enregistré comme conversation dans votre tableau de bord Asyntai, comme un chat sur votre site.

Formules et tarifs

L'intégration GitHub est disponible dans tous les plans Asyntai, y compris le plan gratuit. Chaque réponse compte comme un message de votre quota mensuel, partagé entre tous vos canaux et intégrations. Voir les tarifs.

Désinstallation

Ouvrez vos paramètres GitHub, puis Applications, puis Installed GitHub Apps, et désinstallez Asyntai. L'application cesse de répondre immédiatement. Vous pouvez aussi cliquer sur Déconnecter sur la page GitHub de votre tableau de bord Asyntai.

Besoin d'aide ?

Si vous avez des questions ou rencontrez des problèmes, contactez-nous à [email protected].