Configuração do Claude Code

Claude Code é a ferramenta CLI oficial da Anthropic. Este guia ajudará você a configurar o Claude Code para auxiliá-lo na escrita e manutenção da sua documentação.

Pré-requisitos

• Assinatura ativa do Claude (Pro, Max ou acesso à API)

Configuração

1. Instale o Claude Code globalmente:

npm install -g @anthropic-ai/claude-code

2. Navegue até o diretório da sua documentação.
3. (Opcional) Adicione o arquivo CLAUDE.md abaixo ao seu projeto.
4. Execute claude para iniciar.

Crie o CLAUDE.md

Crie um arquivo CLAUDE.md na raiz do repositório da sua documentação para treinar o Claude Code sobre seus padrões específicos de documentação:

# Documentação Mintlify

## Relação de trabalho
- Você pode contestar ideias — isso pode levar a uma melhor documentação. Cite fontes e explique seu raciocínio ao fazê-lo
- SEMPRE peça esclarecimentos em vez de fazer suposições
- NUNCA minta, adivinhe ou invente informações

## Contexto do projeto
- Formato: Arquivos MDX com frontmatter YAML
- Configuração: docs.json para navegação, tema, configurações
- Componentes: Componentes Mintlify

## Estratégia de conteúdo
- Documente apenas o suficiente para o sucesso do usuário — nem muito, nem pouco
- Priorize a precisão e usabilidade das informações
- Torne o conteúdo atemporal sempre que possível
- Pesquise informações existentes antes de adicionar novo conteúdo. Evite duplicação, a menos que seja feita por motivo estratégico
- Verifique padrões existentes para consistência
- Comece fazendo as alterações menores razoáveis

## Requisitos de frontmatter para páginas
- title: Título claro e descritivo da página
- description: Resumo conciso para SEO/navegação

## Padrões de escrita
- Segunda pessoa ("você")
- Pré-requisitos no início do conteúdo procedimental
- Teste todos os exemplos de código antes de publicar
- Corresponda ao estilo e formatação das páginas existentes
- Inclua casos de uso básicos e avançados
- Tags de linguagem em todos os blocos de código
- Texto alternativo em todas as imagens
- Caminhos relativos para links internos

## Fluxo de trabalho Git
- NUNCA use --no-verify ao fazer commits
- Pergunte como lidar com alterações não commitadas antes de começar
- Crie uma nova branch quando não houver uma branch clara para as alterações
- Faça commits frequentemente durante o desenvolvimento
- NUNCA pule ou desative hooks de pre-commit

## Não faça
- Pule o frontmatter em qualquer arquivo MDX
- Use URLs absolutas para links internos
- Inclua exemplos de código não testados
- Faça suposições — sempre peça esclarecimentos