Integração com o GitHub
Responda a perguntas em Issues e Discussions a partir da sua documentação
Visão Geral
A app GitHub da Asyntai responde às perguntas que as pessoas fazem nos seus repositórios. Quando alguém abre uma Discussion numa categoria Q&A, ou um Issue com a sua etiqueta de pergunta, a Asyntai lê a sua documentação e publica a resposta como comentário. Os seus mantenedores guardam o tempo para relatórios de bugs e código.
Foi feita para projetos que têm a documentação na Asyntai: um site de documentação, um README, um centro de ajuda ou ficheiros carregados. As respostas vêm desse conteúdo, a mesma base de conhecimento que o chat do seu site usa.
Como funciona
A app responde em três lugares:
- Discussions: cada nova discussão numa categoria que aceita respostas, como Q&A.
- Issues: cada novo issue com a etiqueta que escolher. A etiqueta padrão é
question. Relatórios de bugs e pedidos de funcionalidades ficam com a sua equipa. - Seguimento: qualquer pessoa pode mencionar
@asyntai-ai-agentnum comentário para perguntar mais. A app lembra-se do tópico, por isso as perguntas de seguimento são entendidas no contexto.
Cada resposta assenta na sua documentação. Uma pergunta fora da documentação fica aberta para um mantenedor, por isso pode confiar em cada comentário que a app escreve.
Requisitos
- Uma conta Asyntai com a sua documentação na base de conhecimento. O plano gratuito chega para começar.
- Um repositório GitHub, numa conta pessoal ou numa organização, onde possa instalar apps.
- Para Discussions, uma categoria que aceite respostas. O GitHub chama-lhe categoria Q&A.
Instalação
Siga estes passos para adicionar a Asyntai aos seus repositórios:
Instale a app no GitHub
Abra a app Asyntai no GitHub Marketplace e prima Install. Escolha a conta e os repositórios onde pode responder. Pode alterar os repositórios mais tarde nas definições do GitHub.
https://github.com/apps/asyntai-ai-agent
Ligue a sua conta Asyntai
O GitHub envia-o para a Asyntai quando a instalação termina. Inicie sessão, ou crie uma conta gratuita, e escolha o site cuja base de conhecimento a app usa para responder. Só precisa de o fazer uma vez.
Escolha onde responde
Na página GitHub do seu painel Asyntai, ligue ou desligue Discussions e Issues, e defina a etiqueta que marca um issue como pergunta. As definições aplicam-se a todos os repositórios da instalação.
Faça uma pergunta
Abra uma discussão na sua categoria Q&A, ou um issue com a etiqueta de pergunta. A resposta aparece como comentário em menos de um minuto. Mencione a app numa resposta para fazer uma pergunta de seguimento.
Dica: Adicione o seu site de documentação, README e changelog à base de conhecimento no seu painel Asyntai. Quanto mais documentação a app tiver, mais perguntas responde.
O que a app faz
- Responder a perguntas de instalação, configuração e utilização a partir da sua documentação, dia e noite
- Escrever em GitHub Markdown, com blocos de código para comandos e configuração
- Ligar à página de documentação de onde vem a resposta
- Manter o contexto de cada tópico para perguntas de seguimento
- Responder na língua em que a pergunta foi feita
- Deixar relatórios de bugs, pedidos de funcionalidades e pull requests à sua equipa
Permissões
A app pede acesso de leitura e escrita a Issues e Discussions, para ler a pergunta e publicar a resposta, e acesso de leitura aos metadados do repositório.
Privacidade
A Asyntai recebe o texto da pergunta, o nome do repositório e o nome de utilizador GitHub de quem pergunta. Cada tópico respondido é guardado como conversa no seu painel Asyntai, como um chat no seu site.
Planos e preços
A integração com o GitHub está disponível em todos os planos Asyntai, incluindo o gratuito. Cada resposta conta como uma mensagem da sua quota mensal, partilhada por todos os seus canais e integrações. Ver preços.
Desinstalação
Abra as definições do GitHub, depois Applications, depois Installed GitHub Apps, e desinstale a Asyntai. A app deixa de responder de imediato. Também pode premir Desligar na página GitHub do seu painel Asyntai.
Precisa de Ajuda?
Se você tiver alguma dúvida ou encontrar problemas, entre em contato conosco em [email protected].