Domínio personalizado para docs: docs.yourcompany.com configuração
docs.yourcompany.com parece mais profissional do que docsbook.io/yourorg/yourrepo. Também é importante para SEO, confiança e a primeira impressão de "este é um produto real". É assim que configurá-lo corretamente.
TL;DR#
- Decida subdomínio (
docs.yourcompany.com) vs subdiretório (yourcompany.com/docs/) - Adicione um registro CNAME ou A no DNS apontando para o seu host de docs
- Espere a provisão do SSL (geralmente em menos de 5 minutos)
- Configure redirecionamentos de qualquer URL anterior
- Atualize links internos e menções externas
Subdomínio vs subdiretório#
O debate sobre SEO é real. Ambos funcionam em 2026, mas têm diferentes compensações.
Subdomínio (docs.yourcompany.com) |
Subdiretório (yourcompany.com/docs/) |
|
|---|---|---|
| Complexidade de configuração | Mais fácil (um registro DNS) | Mais difícil (proxy reverso ou plataforma compartilhada) |
| Autoridade SEO | Principalmente herdada do domínio raiz | Completamente herdada |
| Flexibilidade de hospedagem | Independente do site principal | Compartilha a infraestrutura do site principal |
| Coesão da marca | Separação clara | Fortemente acoplado |
| Comum em 2026 | Maioria dos sites de documentação | Stripe, GitHub, AWS |
Para a maioria das equipes, o subdomínio é mais fácil e a diferença de SEO é pequena. Vá de subdiretório apenas se o seu site principal estiver em uma plataforma que suporte proxy reverso de forma limpa.
Configurando o subdomínio (exemplo Docsbook)#
Três etapas:
1. No painel do Docsbook#
- Abra as configurações do seu espaço de trabalho
- Configurações → Domínio
- Insira
docs.yourcompany.com - Clique em Salvar
O painel mostra os registros DNS que você precisa adicionar.
2. No seu provedor de DNS#
Adicione um registro CNAME:
Type: CNAME
Name: docs
Value: cname.vercel-dns.com
TTL: 300 (or default)
Se o seu provedor de DNS não suportar CNAME na raiz (achatamento do Cloudflare ou similar), use a alternativa de registro A que sua plataforma fornece.
3. SSL#
SSL é automático. O Docsbook (via Vercel) provisiona um certificado Let's Encrypt em 5 minutos. Você verá o status "Ativo" no painel.
Tempo total: geralmente de 5 a 15 minutos, incluindo a propagação do DNS.
Quando o SSL demora mais#
Se o SSL permanecer "Pendente" após 30 minutos:
- Verifique se o DNS foi propagado globalmente:
dig docs.yourcompany.comdeve resolver para o alvo CNAME - Remova quaisquer registros CAA que bloqueiem o Let's Encrypt
- Verifique se seu domínio já está servindo HTTPS de outro provedor
Redirecionamentos#
Se você hospedou documentos anteriormente em uma URL diferente, configure redirecionamentos 301 para preservar o SEO.
De um subdiretório de docs para o novo subdomínio#
yourcompany.com/docs/* → docs.yourcompany.com/* (301)
A maioria das plataformas suporta isso por meio de regras de redirecionamento.
De GitBook v-paths para Docsbook#
Os URLs do GitBook geralmente têm /v/1.0/ padrões:
docs.yourcompany.com/v/1.0/api/auth → docs.yourcompany.com/api/auth (301)
Se você usar o Cloudflare na frente do seu domínio, pode fazer isso com uma única regra de página. Veja migrando do GitBook para o Docsbook.
Do prefixo Docusaurus à raiz#
Docusaurus frequentemente usa /docs/intro caminhos. Se você achatar para a raiz:
docs.yourcompany.com/docs/* → docs.yourcompany.com/* (301)
Veja migrando do Docusaurus para o Docsbook.
Considerações de SEO#
Três coisas a verificar após a transição:
Console de Pesquisa#
Adicione o novo domínio ao Google Search Console. Envie o sitemap (Docsbook gera automaticamente /sitemap.xml). Acompanhe o relatório de indexação por 4–6 semanas.
Tags canônicos#
Se você mantiver a URL antiga ativa como uma opção de fallback por qualquer motivo, defina tags canônicas na URL antiga apontando para a nova. Um redirecionamento 301 é ainda melhor, pois move leitores e sinais de classificação.
llms.txt propagação#
Quando você move o domínio, os agentes de IA precisam redescobrir seu llms.txt. Eles geralmente fazem isso em algumas varreduras. Verifique:
curl https://docs.yourcompany.com/llms.txt | head -10Veja o guia completo do llms.txt.
O que muda para os usuários#
- Favoritos para URLs antigas: cobertos por redirecionamentos
- Respostas de suporte salvas: atualize-as
- Links internos do produto: atualize-os
- Backlinks externos: permanecem (o 301 transfere autoridade)
A experiência visível para o usuário não deve mudar além da URL.
Suporte a domínio personalizado por plataforma#
| Plataforma | Domínio personalizado suportado | Qual é o custo |
|---|---|---|
| Docsbook | Sim, com SSL automático | Nada — o domínio não consome nada do saldo do projeto; veja docsbook.io/pricing |
| Mintlify | Sim | Em um plano pago — veja mintlify.com/pricing |
| GitBook | Sim | Em um plano pago — veja gitbook.com/pricing |
| ReadMe | Sim | Em um plano pago — veja readme.com/pricing |
| GitHub Pages | Sim | Gratuito |
| Vercel / Netlify | Sim | Nível gratuito, com limites de domínio por conta |
Os preços nesta categoria variam; a página de preços de cada fornecedor é a única fonte confiável, e esta tabela vincula a todas elas em vez de repetir números que podem ficar desatualizados.
Erros comuns#
- Apontar o domínio apex para um CNAME — a maioria dos provedores de DNS não permite isso; use subdomínio (
docs.) ou um registro A achatado - Esquecer de redirecionar — URLs antigas 404 → queda de SEO → perda de autoridade
- HTTPS não forçado — algumas plataformas servem HTTP e HTTPS; force o redirecionamento para HTTPS
- Múltiplos
docssubdomínios — apenas um CNAME por vez, remova os antigos primeiro
Leitura relacionada#
- Migrando do GitBook para o Docsbook
- Migrando do Docusaurus para o Docsbook
- Guia de SEO para documentação
Docsbook serve docs.yourcompany.com com SSL automático, e o domínio não consome nada do saldo do seu projeto.