Guia de onboarding

Quando você entrar pela primeira vez, o Jamdesk iniciará automaticamente sua avaliação gratuita de 14 dias do plano Pro.

• Acesso completo a todos os recursos
• A avaliação 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")
• Esse nome se torna parte da URL do seu site de documentação
• Você pode alterar o nome de exibição posteriormente nas configurações do projeto

O Jamdesk cria um novo repositório do GitHub a partir do Modelo inicial:

• Páginas de exemplo com conteúdo e componentes realistas
• docs.json pré-configurado com navegação e identidade visual
• Exemplo de especificação OpenAPI para documentação de referência da API
• Pronto para editar e enviar imediatamente

A CLI do Jamdesk permite o desenvolvimento local:

npm install -g jamdesk

Você já pode fazer o build! Edite sua documentação:

• Pela CLI: edite arquivos localmente com jamdesk dev
• Pelo GitHub: edite arquivos .mdx diretamente no seu repositório
• No Jamdesk: alguns recursos do dashboard estão disponíveis, dependendo do plano

As alterações acionam automaticamente novos builds da documentação quando você faz push para o GitHub.