Jamdesk Documentation logo

Como o Jamdesk funciona

Como o Jamdesk transforma um git push em um site de documentação no ar em menos de 60 segundos, sem infraestrutura para você gerenciar.

O Jamdesk gera sites de documentação a partir de arquivos MDX no seu repositório do GitHub. Escreva Markdown com componentes React e faça push para o GitHub. Seu site vai ao ar em uma CDN global em menos de 60 segundos. O conteúdo permanece no seu repositório como arquivos MDX simples. Você pode migrá-lo para outra ferramenta a qualquer momento.

Visão geral da arquitetura

Seu repositório é a fonte da verdade. O Jamdesk se conecta a ele, gera seu site e faz o deploy em uma rede de borda global.

Como o conteúdo flui do seu repositório até os seus usuários

O pipeline de build

Um build normalmente leva de 30 a 60 segundos. O Jamdesk não pré-renderiza as páginas. O conteúdo bruto vai para a borda, e as páginas são renderizadas sob demanda quando os visitantes as solicitam.

1
Obtenção do código-fonte

Você faz push para a branch do GitHub conectada (ou clica em Rebuild no painel). O Jamdesk clona seu repositório e localiza o diretório da documentação.

2
Validação

O Jamdesk valida docs.json contra o schema. Verifica os links internos em busca de páginas quebradas e âncoras inválidas.

3
Processamento do conteúdo

O Jamdesk gera a partir do seu conteúdo o índice de busca, os embeddings do chat com IA, o sitemap, o llms.txt e as regras de redirecionamento.

4
Deploy na borda

O conteúdo é enviado para a CDN e se propaga para mais de 300 locais de borda. Somente os arquivos alterados são transferidos.

Incluído em todos os sites

Estes recursos não exigem nenhuma configuração.

Busca com IA

Busca em linguagem natural sobre embeddings vetoriais gerados a partir do seu conteúdo durante o build.

llms.txt

Índice legível por IA que segue a especificação llmstxt.org. Assistentes de programação e agentes de IA leem sua documentação diretamente a partir dele.

Essenciais de SEO

Sitemap, robots.txt, imagens Open Graph e meta tags. Sua documentação é indexável desde o primeiro deploy.

Análises integradas

Painel de análises sem cookies. Você também pode conectar Google Analytics, Plausible, PostHog e outras.

O que aciona um build

Um git push para a branch conectada, o botão Rebuild no painel ou o jamdesk deploy na CLI. O Jamdesk agrupa em um único build os commits enviados em sequência rápida.

Para detalhes operacionais (monitoramento de status, rollbacks, deploys de branches), consulte Ciclo de vida de build e deploy.

Segurança e infraestrutura

Os builds são executados em contêineres isolados. Os builds só leem o seu repositório.

Permissões mínimas

O GitHub App solicita acesso apenas aos repositórios que você selecionar, sem escopos em nível de organização. O Jamdesk só grava no seu repositório quando você salva no editor, aceita edições do Corrigir com IA ou ativa a tradução.

Builds isolados

Cada build recebe seu próprio contêiner, destruído após o deploy. Nada persiste entre builds ou clientes.

HTTPS em todo lugar

Certificados SSL para cada domínio, emitidos e renovados automaticamente.

CDN global

Servido pela rede da Cloudflare, com mais de 300 locais de borda e 99,9% de disponibilidade.

Desempenho

A velocidade de carregamento afeta se a sua documentação é encontrada. O Google usa os Core Web Vitals como sinal de ranqueamento. Rastreadores de IA como GPTBot e ClaudeBot dão a si mesmos de 1 a 5 segundos por página. Documentações que não carregam nesse intervalo não são citadas.

Todo site Jamdesk é servido da borda com tempo até o primeiro byte abaixo de 50 ms. Isso é rápido o suficiente para os limites de ranqueamento do Google e para que rastreadores de IA busquem e citem o conteúdo.

MétricaValor típico
Tempo de build30-60 segundos
Propagação do deploy< 30 segundos
Primeiro byte (borda)< 50 ms
Carregamento completo da página< 500 ms

Próximas etapas

Criar um projeto

Configure um novo site de documentação no painel

Conectar o GitHub

Vincule seu repositório para habilitar builds automáticos

Visualizar localmente

Use a CLI do Jamdesk para visualizar e validar sua documentação antes de fazer push