A instalação e configuração do DeepDocs é muito simples e requer apenas as seguintes etapas:
- Instalando o aplicativo GitHubEm um repositório do GitHub, vá para Configurações > Aplicativos do GitHub, pesquise no Marketplace por DeepDocsAI, clique em Configurar e selecione o repositório de código que deseja monitorar.
- Criação de arquivos de configuraçãoCriar um arquivo de configuração chamado deepdocs.yml no diretório raiz do repositório. Um exemplo de configuração é mostrado abaixo:
target: - url: "docs/" reinit: "random-string" ignore: []
Entre eles, target especifica o caminho do documento monitorado, reinit é usado para acionar a varredura manualmente e ignore especifica os arquivos a serem ignorados.
- Enviar arquivo de configuraçãoComprometer o deepdocs.yml com o branch a ser monitorado (por exemplo, main ou dev) e o DeepDocs acionará automaticamente uma varredura profunda inicial.
Uma vez configurado, o DeepDocs começará a monitorar as alterações de código e atualizará automaticamente a documentação relevante, com todas as atualizações confirmadas como novas ramificações para facilitar a revisão pela equipe.
Essa resposta foi extraída do artigoDeepDocs: a ferramenta de IA do GitHub que atualiza automaticamente a documentação do códigoO
Não pode ser reproduzido sem permissão:Ferramentas de produtividade de IA " Como instalar e configurar o DeepDocs no GitHub?
