Referência de arquitetura técnica
Esta página é para leitores técnicos que precisam entender como o site de documentação Atomicat está organizado e validado.
Estrutura do site
Atomicat Docs é um site de documentação estático construído com Docusaurus. A documentação principal em inglês fica em docs, enquanto a documentação localizada ativa fica nas pastas de locale espanhol e português.
| Área | Propósito |
|---|---|
docs | Fonte da documentação em inglês. |
i18n/es/docusaurus-plugin-content-docs/current | Documentação espanhola ativa. |
i18n/pt/docusaurus-plugin-content-docs/current | Documentação portuguesa ativa. |
static | Arquivos públicos estáticos como robots.txt, _redirects, llms.txt e llms-full.txt. |
src/utils/schemaData.js | Dados FAQ gerados usados para dados estruturados. |
Apenas os locales configurados no Docusaurus fazem parte do build ativo. Outras pastas de locale podem existir para migração ou trabalho histórico, mas não devem ser tratadas como ao vivo a menos que sejam adicionadas à configuração do site.
Modelo de rotas
Cada página de documentação usa frontmatter como path, slug, title e description para controlar roteamento e metadados. A rota em inglês é o caminho base, enquanto rotas localizadas podem usar slugs traduzidos quando o arquivo do locale os define.
Exemplos:
- Inglês:
/builder/settings/seo-meta - Espanhol:
/es/constructor/configuracion/seo-meta - Português:
/pt/construtor/configuracoes/seo-meta
Ao adicionar links internos, use rotas que existem no locale ativo. Links quebrados são detectados pelo build de produção.
Redirects
URLs localizadas legadas ou incorretas são tratadas via static/_redirects. Este arquivo é copiado para a saída do build e deve ser suportado pela plataforma de hospedagem.
Se o host de deploy não suportar _redirects, replique as mesmas regras na configuração de redirect específica do host, como vercel.json, redirects do Cloudflare Pages ou equivalente.
Robots e sitemap
O site publica robots.txt com a localização do sitemap:
https://help.atomicat.com.br/sitemap.xml
O build de sitemap do Docusaurus também produz arquivos de sitemap localizados nas pastas de build por locale. Páginas hub e playbooks recebem sinais de sitemap mais fortes que páginas profundas comuns via changefreq e priority.
Dados estruturados
Conteúdo FAQ é escrito em cada página Markdown com FAQAccordion. O arquivo gerado src/utils/schemaData.js espelha essas perguntas e respostas para extração JSON-LD.
Quando o conteúdo FAQ muda, regenere os dados de schema antes do deploy para que os dados estruturados correspondam ao conteúdo visível da página.
Exportações legíveis por IA
O site inclui:
static/llms.txtpara uma visão geral compacta legível por IA.static/llms-full.txtpara uma exportação Markdown completa do conteúdo de documentação ativo.
Atualize llms-full.txt após grandes mudanças de conteúdo para que motores de busca e resposta de IA leiam a mesma cópia que os visitantes veem.
Checklist de validação
Antes de implantar mudanças na documentação:
- Execute o build de produção.
- Corrija links quebrados reportados pelo Docusaurus.
- Procure linguagem interna que não deveria aparecer em docs voltados ao cliente.
- Confirme que locales ativos foram atualizados quando conteúdo hub em inglês mudar.
- Regenere schema FAQ e exportações legíveis por IA quando FAQ ou blocos de conteúdo mudarem.
- Envie ou atualize o sitemap no Google Search Console após deploy quando páginas sensíveis a SEO mudarem.
Docs relacionados
- Visão geral da referência:
/referencia/visao-geral - Categorias de templates:
/referencia/template-categories - Configurações de metadados SEO:
/construtor/configuracoes/seo-meta - Ferramentas e categorias MCP:
/atomicmcp/ferramentas-categorias