FAQ do Docsbook: custos, limites, sincronização e propriedade dos dados

As perguntas estão ordenadas de acordo com o quanto bloqueiam uma decisão: primeiro o dinheiro, depois como começar e, em seguida, como o produto se comporta quando você já está em operação.

Custos e faturamento#

Quanto custa o Docsbook?#

O Docsbook contabiliza quatro coisas, todas elas relacionadas ao trabalho de IA, cobradas do saldo do projeto que as solicitou:

• Leitores (Chat de IA) — uma resposta de IA fornecida a um leitor da sua documentação.
• Administrador & agente de IA — uma execução de agente iniciada por você ou por um agente conectado.
• Traduções por IA — tradução de uma página para outro idioma.
• Índice semântico — criação dos embeddings que o chat de IA consulta.

Todo o restante não é contabilizado: hospedagem do site, um domínio personalizado e seu certificado TLS, navegação dos leitores, escrita pelos editores, sincronização com o GitHub, pesquisa de texto completo, identidade visual, análises e chamadas de leitura do MCP. Os valores atuais estão em docsbook.io/pricing, que é gerado a partir das constantes de cobrança do Docsbook a cada solicitação — consulte os preços lá, não em uma página de documentação que pode ficar desatualizada. Consulte Preços para entender o mecanismo.

Existe uma forma gratuita de experimentar o Docsbook?#

Sim. Gerar um site de rascunho não exige conta nem cartão de crédito: cole um repositório, a URL de um site ou uma frase sobre o seu produto em docsbook.io/start e leia o resultado antes de iniciar sessão. Cada novo projeto é criado com um saldo de $1.00, e é possível reivindicar mais $5.00 quando o projeto tiver 3 minutos de existência. Ambos são créditos reais para trabalhos de IA.

Como começo a gastar e quanto custa uma recarga?#

O $1,00 com que um projeto do Docsbook começa pode ser gasto imediatamente — faça uma pergunta no chat de IA e você verá o valor ser utilizado. Pressione Reivindicar no cartão de cobrança do projeto quando ele tiver 3 minutos de existência para adicionar o crédito de boas-vindas de $5,00; ninguém o adicionará em seu nome.

Depois disso, você mesmo define o valor. A menor recarga única é de $20,00 e a maior é de $5.000,00; para valores maiores, faça duas recargas. O dinheiro é creditado no saldo do único projeto escolhido. Nada é recarregado automaticamente — configure um pagamento mensal na tela de cobrança se quiser um valor recorrente.

O que acontece quando o saldo de um projeto se esgota?#

O site de documentação continua online. Os leitores continuam a navegar, a pesquisa de texto completo continua a funcionar, a sincronização com o GitHub continua a ser executada e nada é eliminado. O que para é o trabalho de IA contabilizado: a chamada é recusada antes de ser executada, e a recusa indica qual projeto ficou sem saldo, quanto a chamada teria custado, quanto resta e onde recarregar o saldo desse projeto.

As chamadas gratuitas de descoberta através do MCP continuam a funcionar, para que um agente ainda possa relatar o que aconteceu em vez de falhar silenciosamente.

Posso parar de pagar e o que acontece com o meu site de documentação?#

Não há nada para cancelar: você adiciona saldo ao projeto quando quiser, e parar significa não adicionar mais saldo. Seu site de documentação permanece online em docsbook.io/{owner}/{repo}, seu Markdown continua no seu próprio repositório do GitHub e suas configurações — identidade visual, navegação e layout — são preservadas. Nada é excluído.

Se você configurou um pagamento mensal recorrente por conta própria, encerre-o na tela de cobrança em docsbook.io/chat.

Meus arquivos continuam sendo meus?#

Sim. Seu Markdown sempre fica no seu próprio repositório do GitHub. O Docsbook renderiza esses arquivos; ele nunca armazena seu conteúdo em um formato proprietário, e não há nada para exportar primeiro. Aponte outra ferramenta de documentação para o mesmo repositório e você manterá todas as páginas, imagens e links.

Como pago pelo Docsbook?#

A cobrança é processada pela Paddle, que é o comerciante oficial. Abra a tela de cobrança no painel em docsbook.io/chat e adicione saldo a um projeto — no mínimo US$ 20,00 e no máximo US$ 5.000,00. Visa, Mastercard, American Express, Apple Pay e Google Pay são aceitos.

O pagamento é seguro?#

Sim. Os pagamentos são processados pela Paddle como comerciante registrado, e a Docsbook nunca vê o número do seu cartão. Todo o processo de checkout é executado no fluxo hospedado pela própria Paddle.

Uma conta pode gerenciar vários sites de documentação?#

Sim. Uma conta do Docsbook pode ter muitos projetos, e cada projeto mantém seu próprio saldo. O esgotamento do saldo de um projeto não interrompe outro. O projeto que paga por uma chamada tarifada é determinado pela própria chamada — o workspace que você nomeou ou o repositório ao qual ela está associada.

Vocês oferecem reembolsos?#

Envie um e-mail para support@docsbook.io com o endereço da sua conta e o que você pagou. Os reembolsos são tratados caso a caso pela Paddle, que processou o pagamento.

Há descontos para organizações?#

Envie um e-mail para support@docsbook.io para discutir o assunto. Não há nenhum desconto para organizações publicado para citar aqui.

Primeiros passos#

Preciso de um repositório do GitHub para experimentar o Docsbook?#

Não. Em docsbook.io/start, um campo aceita o que você tiver — uma URL de site, um link de repositório, um PDF ou capturas de tela, ou uma frase sobre o que você vende — e gera um site de rascunho a partir disso. Você chega ao painel administrativo do rascunho, com a documentação a um clique de distância, e pode alterar a identidade visual, o layout e o SEO antes de criar uma conta.

O GitHub é necessário apenas para vincular um repositório existente ou quando você publica. Qualquer método de login funciona: GitHub, Google, Apple ou e-mail com um código de uso único.

Que tipo de repositório o Docsbook precisa?#

Qualquer repositório do GitHub que contenha arquivos Markdown. Pode ser um único README.md, uma pasta docs/, uma referência de API ou um conjunto desorganizado de arquivos .md — o Docsbook cria a navegação com base na estrutura disponível.

Preciso configurar alguma coisa no GitHub?#

Não. Autorize o Docsbook por meio do OAuth do GitHub, e ele lerá os arquivos do repositório. Não há nenhum arquivo de workflow para adicionar, nenhuma GitHub Action para instalar e nenhum webhook para registrar.

Que estrutura de pastas devo usar?#

Qualquer estrutura funciona, pois o Docsbook cria a árvore de navegação a partir das pastas que encontra. Um formato comum:

repo/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api/
│   └── guides/

README.md na raiz de uma pasta se torna a página inicial dessa pasta.

Posso usar .markdown em vez de .md?#

Sim. O Docsbook lê tanto .md quanto .markdown. Arquivos em outros formatos — .txt, .rst, .adoc — não são transformados em páginas.

Os links entre arquivos Markdown funcionam?#

Sim. Links relativos entre arquivos Markdown são resolvidos para as URLs publicadas, portanto um link que funciona no GitHub funciona no site. Escreva-os da maneira como você já faz:

[Concepts](/docsbook-io/docs/basics)
[Custom domain](/docsbook-io/docs/guides/advanced/custom-domain)

As âncoras para títulos dentro de uma página (./basics.md#indexing) também são resolvidas.

Como adiciono imagens à minha documentação?#

Coloque o arquivo de imagem no seu repositório — docs/images/ é uma escolha comum — e faça referência a ele usando um caminho relativo. PNG, JPG, GIF e WebP são todos disponibilizados.

![Workspace settings with the API key field highlighted](https://raw.githubusercontent.com/docsbook-io/docs/main/images/workspace-settings.png)

O texto alternativo é o que um leitor de tela e um rastreador de IA leem, portanto descreva o que a imagem mostra em vez de nomear o arquivo.

Posso usar HTML no meu Markdown?#

Sim. O Markdown permite HTML embutido, e o Docsbook o renderiza. O Markdown simples ainda é a melhor opção padrão, pois continua legível no GitHub, em um editor e por um agente via MCP.

Como alterno entre contas e organizações do GitHub?#

Clique no botão do GitHub no canto superior direito do chat de IA. Ele abre um seletor que lista sua conta conectada e todas as organizações do GitHub das quais você faz parte. Um ponto verde no botão significa que o GitHub está conectado. Passe o cursor sobre qualquer conta ou organização — toque, em uma tela sensível ao toque — para ver seus repositórios e conecte um deles como um novo projeto a partir daí.

Posso mover um projeto hospedado no Docsbook para meu próprio repositório do GitHub?#

Sim, usando o mesmo botão do GitHub. O Docsbook cria o repositório na sua conta, copia todas as páginas para ele em um único commit e aponta o projeto para esse repositório; suas edições passam então a ser confirmadas diretamente no seu repositório.

Duas consequências antes de mover: o URL público muda, e o endereço hospedado anteriormente deixa de funcionar sem redirecionamento, portanto atualize todos os lugares onde você o compartilhou. E a mudança é irreversível — não há um botão para mover um projeto de volta para a hospedagem do Docsbook.

Publicação e sincronização#

Como atualizo minha documentação do Docsbook?#

Edite o arquivo Markdown e faça commit dele no GitHub. O site detecta a alteração na próxima visita — não há uma compilação para acionar nem uma implantação para aguardar. Você também pode editar no editor web do Docsbook ou por meio de um agente via MCP; todas as três opções resultam em commits no mesmo repositório.

Com que rapidez um site do Docsbook é atualizado após um push?#

Na próxima visita. O Docsbook verifica se há novos commits no GitHub quando o site é carregado e reindexa o que mudou, portanto a página que você abre é criada com base no estado atual do repositório, e não em uma versão armazenada em cache.

Por que meu site do Docsbook não foi atualizado?#

Siga estas quatro etapas, nesta ordem:

1. O commit está realmente no GitHub? Verifique o arquivo em github.com.
2. Você atualizou completamente o navegador (Ctrl+F5 ou Cmd+Shift+R)?
3. Já se passou um ou dois minutos desde o commit?
4. O arquivo termina em .md ou .markdown? Outras extensões não são indexadas.

Se os quatro itens estiverem corretos, envie um e-mail para support@docsbook.io com o repositório e o commit.

A pesquisa no site do Docsbook funciona?#

Sim. Todo site do Docsbook tem pesquisa de texto completo integrada em todas as suas páginas. Clique no ícone de pesquisa no cabeçalho ou pressione Cmd+K no macOS e Ctrl+K no Windows e no Linux.

Existe um tema escuro?#

Sim. Os temas claro, escuro e seguir o sistema são todos compatíveis. O proprietário do espaço de trabalho escolhe o padrão nas configurações de marca, e os leitores podem alterá-lo no seletor de tema do cabeçalho.

Quantos visitantes simultâneos um site Docsbook pode suportar?#

Os sites Docsbook são servidos pela CDN da Vercel, que escala automaticamente. Não há limite de visitantes para configurar nem nível de tráfego para contratar.

Acesso e privacidade#

Quem pode ver minha documentação do Docsbook?#

Por padrão, todos: qualquer pessoa com o link, pessoas sem uma conta do GitHub e rastreadores de mecanismos de busca. Geralmente, é isso que você quer, porque um site público é o que o Google indexa e o que um assistente de IA pode citar.

Você pode alterar isso — veja a próxima resposta.

Posso tornar minha documentação privada?#

Sim. Mude o espaço de trabalho para privado e os leitores verão uma tela de desbloqueio em vez do seu conteúdo, protegida por uma senha compartilhada ou pelo seu próprio provedor de identidade SSO. A estrutura, as páginas e o índice de pesquisa permanecem ocultos até que um leitor o desbloqueie, e o proprietário sempre tem acesso completo.

Consulte Documentação privada: senha e SSO para configurar.

Um repositório privado do GitHub torna o site publicado privado?#

Não. As duas configurações são independentes. O Docsbook lê o repositório por meio da autorização do GitHub que você concedeu e, em seguida, disponibiliza as páginas que criou; quem pode ler essas páginas é definido nas próprias configurações de acesso do Docsbook, não pela visibilidade do repositório.

Minha documentação é servida por HTTPS?#

Sim. Todo site do Docsbook é servido por HTTPS por meio da CDN da Vercel, e um domínio personalizado tem seu certificado TLS provisionado automaticamente.

Outra pessoa pode editar minha documentação por meio do Docsbook?#

Não, a menos que você tenha dado acesso ao repositório. O Docsbook registra as alterações como commits no repositório a partir do qual o site é criado, portanto, as permissões do repositório determinam quem pode alterar o quê.

Quem vê o widget flutuante?#

Apenas você, enquanto estiver conectado e visualizando sua própria documentação. Os leitores veem a documentação e nada mais — o widget flutuante nem sequer é renderizado para eles.

Domínio personalizado#

Como uso meu próprio domínio para o Docsbook?#

Insira o domínio nas configurações do seu workspace, adicione o registro CNAME que o Docsbook mostra no seu provedor de DNS e aguarde a propagação. O Docsbook provisiona o certificado TLS por conta própria.

Guia completo: Configuração de domínio personalizado.

Devo usar um domínio raiz ou um subdomínio para a documentação?#

Geralmente, um subdomínio — docs.example.com. É um único registro CNAME e mantém seu domínio raiz livre para o site de marketing. Um domínio raiz funciona, assim como vários subdomínios apontando para diferentes espaços de trabalho.

Preciso configurar o SSL por conta própria?#

Não. O Docsbook provisiona e renova automaticamente o certificado TLS para o seu domínio personalizado, sem custo adicional e sem que você precise configurar nada.

Quanto tempo demora a propagação do DNS?#

Normalmente, de 15 a 30 minutos, e até 48 horas no pior caso. O atraso ocorre no seu provedor de DNS, não no Docsbook — o domínio começa a funcionar assim que o registro é resolvido.

Traduções#

Como traduzo minha documentação do Docsbook?#

Abra as configurações do seu workspace, selecione os idiomas de destino e salve. O Docsbook traduz as páginas e disponibiliza cada idioma em sua própria rota. A tradução é um trabalho de IA, portanto utiliza o saldo do projeto.

Guia completo: Tradução e i18n.

Quais idiomas o Docsbook oferece suporte?#

15: Inglês, espanhol, francês, alemão, português, italiano, russo, chinês, japonês, coreano, árabe, hindi, turco, polonês e holandês. Cada idioma é disponibilizado em sua própria rota com as tags hreflang corretas, para que os mecanismos de pesquisa o indexem como uma página separada.

Quão boa é a tradução por IA do Docsbook?#

Boa o suficiente para publicar documentação técnica, na qual o vocabulário é consistente e as frases são curtas. Idiomas, piadas e exemplos específicos de uma cultura são os casos em que é necessária uma revisão humana — leia essas páginas antes de anunciar o idioma.

As traduções são atualizadas quando atualizo o original?#

Sim. Quando a página de origem muda, o Docsbook a traduz novamente, para que uma versão em outro idioma não se afaste silenciosamente do inglês.

Posso editar uma tradução manualmente?#

Sim. As traduções podem ser baixadas, corrigidas e carregadas novamente. Envie um e-mail para support@docsbook.io se quiser que o processo seja explicado.

IA e agentes#

O que são SEO, GEO e AEO, e por que são importantes para a documentação?#

O SEO coloca sua documentação nos resultados do Google. O GEO — otimização para mecanismos generativos — coloca-a nas respostas de IA: citações do Perplexity, Pesquisa do ChatGPT, Visões gerais de IA do Google. O AEO — otimização para mecanismos de resposta — adiciona a marcação estruturada que os snippets em destaque e os assistentes de voz leem.

O Docsbook gera os três a partir do seu Markdown: meta tags, sitemap.xml, OpenGraph, URLs canônicas, blocos de TL;DR, um dateModified visível, marcação de autor, JSON-LD de FAQPage e HowTo e seletores speakable. Consulte SEO, GEO e AEO.

O que são as habilidades do Docsbook?#

As habilidades do Docsbook são arquivos SKILL.md que ensinam um agente de IA a realizar trabalhos de documentação. O catálogo contém quatro habilidades de orquestração, uma por tarefa: docs-analyze encontra o que está errado, docs-create escreve o que está faltando, docs-manage decide o que uma página deve dizer e docs-automate faz com que qualquer uma delas se repita.

Instale-as com npx skills add Docsbook-io/docs-skills --skill '*' ou permita que um agente conectado ao MCP as descubra em tempo de execução com find_skill. Consulte Habilidades de documentação.

Um agente de IA pode editar minha documentação?#

Sim. O servidor MCP do Docsbook expõe 309 ferramentas em https://docsbook.io/api/mcp/server, para que o Claude Code, o Cursor ou o ChatGPT possam ler suas páginas, pesquisá-las, alterar configurações e confirmar novas páginas. A escrita requer um token autorizado com escopo de leitura e escrita; um token somente leitura é recusado.

Consulte o servidor MCP e a referência das ferramentas MCP.

Migrando de outra ferramenta#

Como migro do GitBook para o Docsbook?#

Três etapas:

1. Exporte do GitBook. O GitBook pode sincronizar com um repositório Git ou exportar Markdown como um .zip. Envie os arquivos .md resultantes para um repositório do GitHub — qualquer estrutura funciona.
2. Conecte o repositório. Cole github.com/your-org/your-repo em docsbook.io/start.
3. Aponte novamente seu domínio. Remova o domínio personalizado no GitBook, adicione-o no Docsbook e atualize o registro CNAME. O certificado TLS é provisionado para você.

O que é transferido automaticamente: estrutura das páginas, links internos (os caminhos relativos .md são resolvidos), imagens, blocos de código GFM, títulos e frontmatter. O que você refaz: identidade visual, links de navegação e as perguntas sugeridas pelo chat de IA. Comparação lado a lado: GitBook vs Docsbook.

O que acontece com meus documentos se o Docsbook for encerrado?#

Nada é perdido. Seus arquivos Markdown ficam no seu próprio repositório do GitHub, em um formato aberto e com o histórico. Aponte outra ferramenta para o mesmo repositório e mantenha tudo — não há nenhum armazenamento proprietário do qual escapar nem nenhuma exportação a solicitar.

Suporte, jurídico e técnico#

Como entro em contato com o suporte do Docsbook?#

Envie um e-mail para support@docsbook.io ou pergunte no Discord do Docsbook. Inclua o endereço do seu projeto — docsbook.io/{owner}/{repo} — para que possamos consultar o site correto.

O que devo fazer se algo estiver quebrado?#

Envie um e-mail para support@docsbook.io com três informações: a URL da página, o que você esperava e o que aconteceu. Uma captura de tela ajuda; o SHA do commit ajuda ainda mais se o problema estiver relacionado a conteúdo que não apareceu.

Onde posso ver as atualizações do produto Docsbook?#

O changelog registra cada alteração lançada e o benefício que ela pretendia proporcionar. Anúncios mais curtos são publicados em twitter.com/docsbook.

Com o que o Docsbook foi desenvolvido?#

Next.js 16, React 19, TypeScript e Tailwind CSS na Vercel, com Postgres (Neon) e Redis por trás, Drizzle como ORM, Paddle para cobrança e a API do GitHub para acesso aos repositórios. As chamadas de IA são encaminhadas pelo OpenRouter ou pela sua própria chave de provedor.

Onde os dados do Docsbook são armazenados?#

Na infraestrutura da Vercel e no Neon Postgres, hospedados nos Estados Unidos e em outras regiões. O conteúdo da sua documentação permanece no seu repositório do GitHub — o Docsbook armazena o índice que cria a partir dele, não uma segunda cópia da sua fonte de verdade.

Qual analisador de Markdown o Docsbook usa?#

remark e rehype, por meio do unified, com suporte ao GitHub Flavored Markdown (GFM). A navegação e a resolução de links usam markdown-lsp, o analisador de documentação de código aberto do Docsbook, e o realce de sintaxe usa o Shiki.

Existem Termos de Serviço e uma Política de Privacidade?#

Sim: Termos e Privacidade. Se um site violar os termos, a Docsbook entra primeiro em contato com o proprietário e normalmente dá a ele a oportunidade de corrigir o problema antes que qualquer outra medida seja tomada.

Relacionado#

• Preços — o que é medido e pelo que o saldo de um projeto paga
• Início rápido — publique um site de documentação, do código-fonte à URL pública
• Conceitos — todos os termos usados acima, definidos uma vez
• Casos de uso — as tarefas para as quais as equipes contratam documentação