---
title: Guia de onboarding
description: "Conclua o onboarding para configurar seu primeiro site de documentação: crie um projeto, conecte o GitHub, configure o docs.json e faça o primeiro build."
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://jamdesk.com/docs/llms.txt). Append `.md` to any page URL for its markdown version.

## As 5 etapas

### 1. Iniciar avaliação

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

### 2. Criar projeto

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

### 3. Conectar o GitHub e criar documentação inicial

O Jamdesk cria um novo repositório do GitHub a partir do [Modelo inicial](https://github.com/jamdesk/starter-docs):

- 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

### 4. Instalar CLI

A CLI do Jamdesk permite o desenvolvimento local:

```bash
npm install -g jamdesk
```

<Note>
Você pode ignorar esta etapa durante o onboarding e instalar a CLI a qualquer momento. Se ignorá-la, ainda poderá editar a documentação diretamente no GitHub.
</Note>

### 5. Começar a editar

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.

## Após o onboarding

Depois de concluir o onboarding, você poderá:
- [Criar projetos adicionais](https://jamdesk.com/docs/pt/help/projects/creating)
- [Convidar membros da equipe](https://jamdesk.com/docs/pt/help/projects/team-members)
- [Ver análises](https://jamdesk.com/docs/pt/setup/analytics-overview)
- [Configurar domínios personalizados](https://jamdesk.com/docs/pt/deploy/custom-domains)

## Solução de problemas

### Ignorei uma etapa. Posso voltar?
Você pode concluir o onboarding a qualquer momento no dashboard do seu projeto. Procure o cartão de onboarding para continuar de onde parou.

### Escolhi o repositório do GitHub errado
Crie um novo projeto com o repositório correto. Você pode excluir o projeto antigo a qualquer momento.

### Preciso de ajuda durante o onboarding
Entre em contato com o [suporte](https://jamdesk.com/docs/pt/help/support/contact) a qualquer momento durante o processo.

## Artigos relacionados

<Columns cols={2}>
  <Card title="Primeiro build" icon="hammer" href="/pt/help/getting-started/first-build">
    Acione e verifique seu primeiro build
  </Card>
  <Card title="Tour pelo dashboard" icon="compass" href="/pt/help/getting-started/dashboard-tour">
    Conheça o dashboard do Jamdesk
  </Card>
</Columns>