Pular para o conteúdo principal

Acessando Resultados Gerados

Quando uma task termina com sucesso, o Smart Engineering disponibiliza resultados no workspace do repositório, na visão global de documentação, nas telas de grafo e em pacotes .zip quando houver download disponível.

Quando usar​

  • Use documentação para ler páginas geradas dentro da aplicação.
  • Use download quando os artefatos precisam ser compartilhados, arquivados ou editados fora da aplicação.
  • Use o grafo para investigar relações técnicas e dependências do código analisado.

Documentação​

Abra /repositories/:repositoryId/documentation para ler documentação de um repositório, ou /documentation para começar pela visão global.

A documentação carrega sob demanda:

  1. O app busca as páginas de documentação disponíveis.
  2. Monta a navegação lateral.
  3. Abre a primeira página disponível por padrão.
  4. Busca o conteúdo da página quando o usuário navega.

Isso evita carregar todo o conteúdo de uma vez e permite navegar por páginas reais. A tela permite:

  • Carregar documentação do repositório.
  • Selecionar um repositório com documentação disponível.
  • Ver repositórios indisponíveis separadamente.
  • Buscar arquivos ou categorias.
  • Navegar pela árvore lateral.
  • Abrir páginas Markdown.
  • Ler Markdown renderizado.
  • Abrir diagramas Mermaid.
  • Recarregar documentação.
  • Voltar para a tela anterior sem entrar em loop.
  • Baixar resultados quando houver pacote disponível.

Estados possíveis incluem seleção de repositório, carregamento, documentação carregada, documentação vazia, erro de carregamento e busca sem resultados.

Baixando o pacote de resultado​

Você também pode baixar o resultado de uma task concluída.

  1. Abra a task concluída.
  2. Clique em Download Results.
  3. Extraia o arquivo .zip.
  4. Abra arquivos HTML ou Markdown localmente.

Dependendo das opções da task, o pacote pode incluir documentação, diagramas, artefatos de backlog e arquivos de apoio.

Grafo do repositório​

Abra /repositories/:repositoryId/graph para explorar relações identificadas no código analisado. O grafo ajuda usuários técnicos a investigar nós, relacionamentos, arquivos, elementos de código, dependências e referências.

Você pode buscar arquivos, selecionar arquivos ou elementos de código, inspecionar referências, abrir documentação relacionada e usar assistência de IA quando estiver configurada.

A assistência de IA depende dos modelos e da configuração disponíveis para a organização.

Grafo global​

Abra o grafo global para trabalhar fora do workspace de um repositório específico. Ele possui dois modos:

  • Selecionar repositório existente: escolha um repositório disponível e carregue o grafo. Repositórios sem código-fonte não devem aparecer como opções carregáveis.
  • Enviar código: envie um .zip para gerar grafo a partir do código informado.

Resultado esperado​

Você deve conseguir navegar pela documentação live por página, explorar relações técnicas em grafos de repositório ou globais, usar chat quando configurado e baixar um pacote com artefatos gerados quando disponível.

Veja também​