Walkthrough de integração
Siga o fluxo guiado de integração para configurar seu primeiro site de documentação: crie um projeto, conecte o GitHub, configure o docs.json e dispare seu primeiro build.
As 5 etapas
O Jamdesk inicia seu teste gratuito de 14 dias do plano Pro no primeiro login.
- Todos os recursos estão ativados
- O teste termina 14 dias após a ativação
Dê um nome ao seu projeto de documentação:
- Use um nome claro e descritivo (por exemplo, "Documentação da API", "Guia do usuário")
- O nome se torna parte da URL do seu site de documentação
- Você pode alterar o nome de exibição depois nas configurações do projeto
O Jamdesk cria um novo repositório no GitHub a partir do Starter Template:
- Páginas de exemplo com conteúdo e componentes realistas
docs.jsonpré-configurado com navegação e identidade visual- Exemplo de especificação OpenAPI para documentação de referência de API
- Pronto para editar e enviar
Instale a CLI do Jamdesk para desenvolvimento local:
npm install -g jamdeskEsta etapa é opcional. Instale a CLI a qualquer momento ou edite a documentação diretamente no GitHub.
Edite sua documentação:
- Via CLI: edite os arquivos localmente com
jamdesk dev - Via GitHub: edite os arquivos
.mdxdiretamente no seu repositório - No Jamdesk: alguns recursos do painel estão disponíveis (dependendo do plano)
Cada envio para o GitHub dispara um novo build.
Após o onboarding
Em seguida, você pode:
- Criar projetos adicionais
- Convidar membros da equipe
- Ver análises
- Configurar domínios personalizados
Solução de problemas
Ignorei uma etapa. Posso voltar?
Sim. Você pode concluir a integração a qualquer momento pelo cartão de integração no painel do seu projeto.
Escolhi o repositório do GitHub errado
Crie um novo projeto com o repositório correto. Você pode excluir o antigo a qualquer momento.
Preciso de ajuda durante o onboarding
Entre em contato com o suporte.
