Skip to main content

Technical architecture reference

This page is for technical readers who need to understand how the Atomicat documentation site is organized and validated.

Site structure​

Atomicat Docs is a static documentation site built with Docusaurus. The main English docs live under docs, while active localized docs live under the Spanish and Portuguese locale folders.

AreaPurpose
docsEnglish documentation source.
i18n/es/docusaurus-plugin-content-docs/currentActive Spanish documentation.
i18n/pt/docusaurus-plugin-content-docs/currentActive Portuguese documentation.
staticStatic public files such as robots.txt, _redirects, llms.txt, and llms-full.txt.
src/utils/schemaData.jsGenerated FAQ data used for structured data.

Only the locales configured in Docusaurus are part of the active build. Other locale folders may exist for migration or historical work, but they should not be treated as live unless they are added to the site configuration.

Route model​

Each documentation page uses frontmatter such as path, slug, title, and description to control routing and metadata. The English route is the base path, while localized routes can use translated slugs when the locale file defines them.

Examples:

  • English: /builder/settings/seo-meta
  • Spanish: /es/constructor/configuracion/seo-meta
  • Portuguese: /pt/construtor/configuracoes/seo-meta

When adding internal links, use routes that exist in the active locale. Broken links are caught by the production build.

Redirects​

Legacy or incorrect localized URLs are handled through static/_redirects. This file is copied into the build output and should be supported by the hosting platform.

If the deployment host does not support _redirects, mirror the same rules in the host-specific redirect configuration, such as vercel.json, Cloudflare Pages redirects, or another equivalent.

Robots and sitemap​

The site publishes robots.txt with the sitemap location:

  • https://help.atomicat.com.br/sitemap.xml

The Docusaurus sitemap build also produces localized sitemap files under locale build folders. Hub pages and playbooks receive stronger sitemap signals than ordinary deep pages through changefreq and priority.

Structured data​

FAQ content is written in each Markdown page with FAQAccordion. The generated src/utils/schemaData.js file mirrors those FAQ questions and answers for JSON-LD extraction.

When FAQ content changes, regenerate the schema data before deploying so structured data matches the visible page content.

AI-readable exports​

The site includes:

  • static/llms.txt for a compact AI-readable overview.
  • static/llms-full.txt for a full Markdown export of active documentation content.

Update llms-full.txt after large content changes so AI search and answer engines read the same copy visitors see.

Validation checklist​

Before deploying documentation changes:

  1. Run the production build.
  2. Fix any broken links reported by Docusaurus.
  3. Search for leftover internal-only language that should not appear in customer-facing docs.
  4. Confirm active locales are updated when English hub content changes.
  5. Regenerate FAQ schema and AI-readable exports when FAQ or content blocks change.
  6. Submit or refresh the sitemap in Google Search Console after deployment when SEO-sensitive pages change.
  • Reference overview: /reference/overview
  • Template categories: /reference/template-categories
  • SEO metadata settings: /builder/settings/seo-meta
  • MCP tools and categories: /mcp/tools-and-categories