O recurso de varredura profunda do DeepDocs é usado principalmente para inspecionar completamente todos os documentos na base de código e corrigir conteúdo desatualizado em massa. Isso é especialmente útil para projetos que não atualizam sua documentação há muito tempo e pode resolver um grande número de inconsistências de documentação e código de uma só vez.
Os principais recursos da varredura profunda incluem:
- Analisar de forma abrangente toda a base de código e identificar todos os documentos que precisam ser atualizados.
- Gera um ramo separado contendo todas as alterações, com um nome de ramo no formato deepdocs-deepscan--.
- Forneça um relatório de alterações detalhado que liste cada arquivo atualizado, o motivo da alteração e o commit do código associado.
Acionar uma varredura profunda é simples: basta alterar a string reinit (qualquer string aleatória) no arquivo de configuração deepdocs.yml e confirmar essa alteração; o DeepDocs detecta a alteração reinit e inicia automaticamente uma varredura completa.
Esse recurso é particularmente adequado para cenários em que você precisa atualizar uma grande quantidade de documentação após a refatoração de um projeto ou precisa limpar a dívida técnica ao assumir um projeto legado.
Essa resposta foi extraída do artigoDeepDocs: a ferramenta de IA do GitHub que atualiza automaticamente a documentação do códigoO
