Corrigir com IA
Revise e aplique correções sugeridas por IA para links quebrados e descrições ausentes no dashboard de build do Jamdesk, com commit no GitHub.
Quando um build termina com links quebrados ou páginas sem descrição, o Jamdesk pode corrigir muitos deles para você. O botão Fix with AI lê os avisos do build, propõe uma edição concreta para cada um e faz commit das correções aprovadas no seu repositório GitHub conectado, iniciando um novo build. Esta página é para quem mantém um site Jamdesk e quer eliminar avisos de build sem editar MDX manualmente.
As capturas de tela mostram a interface em inglês.
Para uma versão local, baseada em terminal, da mesma ideia, consulte o comando jamdesk fix da CLI. O fluxo do dashboard faz o commit por você; a CLI grava na sua cópia de trabalho e deixa o commit por sua conta.
O que ele corrige
O Fix with AI funciona com três tipos de aviso de build:
- Links internos quebrados. Um fragmento de link aponta para um título que não existe mais na página de destino, como um erro de digitação (
#instalation→#installation), ou uma página traduzida cujo título foi renomeado. - Descrições de página ausentes. Uma página não tem
descriptionno frontmatter. O Jamdesk escreve um breve resumo com base no conteúdo da página para você revisar. - Títulos de página ausentes. Uma página sem título recebe uma sugestão baseada no conteúdo da página para você revisar.
Uma alteração só é proposta quando o destino pode ser resolvido com segurança. Tudo que for ambíguo permanece inalterado e é listado separadamente para que você possa corrigir manualmente.
A quantidade de itens corrigíveis não é igual à quantidade de avisos. Um build pode mostrar cinco avisos enquanto o Fix with AI oferece corrigir três deles, porque os outros dois não têm uma correção inequívoca. O banner sempre reflete o que pode ser corrigido de fato.
Pré-requisitos
- Um repositório GitHub conectado ao projeto.
- Acesso de gravação ao Jamdesk GitHub App para que ele possa fazer commit das correções. Se o acesso estiver ausente, o modal mostrará um link Grant access que levará você ao GitHub para adicioná-lo.
- Um build concluído com avisos de links quebrados ou descrições ausentes.
Encontre o banner
Abra o projeto e role até Build History na página Project Home. Quando o build mais recente tiver problemas corrigíveis, um banner aparecerá acima da lista de builds com a quantidade de itens e um botão Fix with AI.
O banner aparece somente no build concluído mais recente. Builds anteriores do histórico não o mostram, porque as correções sempre se aplicam ao estado atual da sua documentação.
Revise e aplique as correções
Clique em Fix with AI. O modal é aberto e o agente de IA revisa sua documentação para criar um plano de correção. Isso leva alguns segundos.
As correções são agrupadas por tipo. Broken links mostra cada âncora reescrita, Missing descriptions mostra o resumo sugerido para cada página e Missing titles mostra o título proposto. Desmarque a caixa de seleção de qualquer item que preferir ignorar desta vez ou use o botão de ignorar para silenciar uma recomendação permanentemente. Os problemas sem uma correção clara aparecem em Can't be fixed automatically e ficam para você resolver manualmente.
Clique em Apply fixes. O Jamdesk faz commit das alterações selecionadas no branch conectado, com a mensagem docs: apply AI-suggested fixes (via Jamdesk), e inicia um novo build.
Acompanhe o novo build em Build History. Quando ele for publicado, os avisos corrigidos desaparecerão. Tudo que permanecer será um aviso que o Fix with AI não conseguiu resolver ou um novo problema decorrente do conteúdo mais recente.
A aplicação grava um commit real no seu repositório, portanto a alteração fica registrada no histórico do Git e você pode revisá-la ou revertê-la no GitHub como qualquer outro commit.
Quando alguns problemas não podem ser corrigidos
Se um aviso não tiver uma correção clara, o modal o listará sob um título separado e não fará alterações. Motivos comuns:
- Um link quebrado cujo destino ou título não existe em nenhum lugar, portanto não há para onde apontá-lo.
- Uma entrada de navegação sem um arquivo de origem correspondente.
- Uma página para a qual o agente não conseguiu gerar uma descrição automaticamente.
Esses casos exigem uma edição manual. Abra a página no editor ou no seu editor de código, corrija o link ou adicione a descrição e faça push para iniciar um novo build.
Ignorar recomendações
Alguns avisos não justificam uma ação: um link que você quebrou de propósito ou uma página provisória que não precisa de descrição. Desmarcar uma correção apenas a ignora uma vez. Ignorá-la remove o item da contagem até que você decida o contrário.
Cada linha do modal, corrigível ou não, tem um botão de ignorar. Clique nele e o item será movido para uma seção Ignored recolhida na parte inferior. Quando você fechar o modal, a contagem do banner na página Project Home diminuirá para corresponder, e os avisos correspondentes desaparecerão do Build History, no build atual e em todos os builds posteriores. Ignore all faz o mesmo com tudo que ainda estiver listado.
Como as opções de ignorar funcionam:
- Compartilhadas e persistentes. As opções de ignorar se aplicam ao projeto inteiro, portanto todos os membros veem a mesma lista, que permanece entre builds. O Jamdesk identifica cada aviso pelo conteúdo, e não pelo número da linha, portanto editar outras partes da página não fará um item ignorado voltar.
- Restaurar. Expanda a seção Ignored e clique em Restore em qualquer item. Se você ignorar tudo em um build, o banner desaparecerá e um pequeno link "N ignored recommendations" sob Build History reabrirá o modal.
- Avisos alterados voltam a aparecer. Se o problema subjacente mudar, por exemplo, se o link quebrado passar a apontar para outro lugar, ele não corresponderá mais à entrada ignorada e aparecerá novamente como uma nova recomendação.
Fix with AI vs. a CLI
As duas ferramentas corrigem âncoras de links quebrados. Elas diferem quanto ao local de execução e à forma como a alteração é aplicada.
| Fix with AI (dashboard) | jamdesk fix (CLI) | |
|---|---|---|
| Execução | No dashboard, em um build | No seu terminal, usando arquivos locais |
| Correções | Links quebrados e descrições ausentes | Âncoras de links quebrados |
| Commit | Faz commit no seu branch por você | Grava arquivos locais; você faz o commit |
| Acionamento | Um clique no banner do build | jamdesk fix |
Use o fluxo do dashboard para uma correção rápida sem sair do Jamdesk. Use a CLI quando quiser primeiro colocar as alterações na sua cópia de trabalho, por exemplo, para agrupá-las com outras edições.