Guia de documentação

Este diretório é responsável pela criação da documentação, pelas regras de links do Mintlify e pela política de internacionalização da documentação.

Regras do Mintlify

• A documentação é hospedada no Mintlify (https://docs.openclaw.ai).
• Os links internos da documentação em docs/**/*.md devem permanecer relativos à raiz, sem o sufixo .md ou .mdx (exemplo: [Configuração](/gateway/configuration)).
• As referências cruzadas a seções devem usar âncoras em caminhos relativos à raiz (exemplo: [Hooks](/gateway/configuration-reference#hooks)).
• Os títulos da documentação devem evitar travessões e apóstrofos, pois a geração de âncoras do Mintlify é frágil nesses casos.
• O README e outros documentos renderizados pelo GitHub devem manter URLs absolutas da documentação para que os links funcionem fora do Mintlify.
• O conteúdo da documentação deve permanecer genérico: sem nomes pessoais de dispositivos, nomes de host ou caminhos locais; use espaços reservados como user@gateway-host.

Regras de conteúdo da documentação

• Na documentação, nos textos da interface e nas listas de seleção, ordene os serviços/provedores alfabeticamente, a menos que a seção descreva explicitamente a ordem de execução ou de detecção automática.
• Mantenha a nomenclatura dos plugins incluídos consistente com as regras de terminologia de plugins de todo o repositório no AGENTS.md raiz.
• Documentação gerada, nunca edite manualmente: docs/plugins/reference/**, docs/plugins/reference.md e docs/plugins/plugin-inventory.md são gerados por pnpm plugins:inventory:gen; docs/docs_map.md, por pnpm docs:map:gen; e docs/maturity/**, por pnpm maturity:render.

Documentação interna

• A documentação privada de longa duração para operadores deve ficar em ~/Projects/manager/docs/.
• Documentos internos locais do repositório usados como rascunhos ou espelhos podem ficar no diretório ignorado docs/internal/.
• Nunca adicione páginas de docs/internal/** à navegação de docs/docs.json nem crie links para elas na documentação pública.
• scripts/docs-sync-publish.mjs exclui e remove docs/internal/** do repositório público de publicação openclaw/docs caso uma página seja adicionada à força posteriormente.
• A documentação interna pode mencionar caminhos do repositório, nomes de aplicativos privados, nomes de itens do 1Password e procedimentos operacionais, mas nunca deve incluir valores secretos.

Edição do quadro de pontuação de maturidade

taxonomy.yaml e qa/maturity-scores.yaml são as entradas de origem; os documentos de maturidade gerados em docs/maturity/ são projeções e não devem ser editados manualmente quanto à pontuação, ao LTS, à taxonomia, ao perfil de QA ou às tabelas de evidências. scripts/qa/render-maturity-docs.ts é responsável pela geração; use pnpm maturity:render para atualizar os documentos versionados e pnpm maturity:check para verificá-los. .github/workflows/maturity-scorecard.yml renderiza prévias dos artefatos e pode abrir PRs de documentos gerados; .github/workflows/openclaw-release-checks.yml o aciona para o QA de lançamentos. Mantenha os dados determinísticos de qa-evidence.json.scorecard nos artefatos do GitHub Actions, a menos que um mantenedor solicite explicitamente uma projeção sanitizada e versionada. As substituições manuais devem alterar o estado de origem em um PR e explicar o motivo, juntamente com evidências públicas ou expurgadas.

Internacionalização da documentação

• A documentação em outros idiomas não é mantida neste repositório. A saída de publicação gerada fica no repositório separado openclaw/docs (frequentemente clonado localmente como ../openclaw-docs).
• Não adicione nem edite documentação localizada em docs/<locale>/** aqui.
• Considere a documentação em inglês deste repositório, juntamente com os arquivos de glossário, como a fonte oficial.
• Pipeline: atualize aqui a documentação em inglês, atualize docs/.i18n/glossary.<locale>.json conforme necessário e, em seguida, deixe que a sincronização do repositório de publicação e scripts/docs-i18n sejam executados em openclaw/docs.
• Antes de executar novamente scripts/docs-i18n, adicione entradas ao glossário para quaisquer novos termos técnicos, títulos de páginas ou rótulos curtos de navegação que devam permanecer em inglês ou usar uma tradução fixa.
• pnpm docs:check-i18n-glossary é a verificação de proteção para títulos alterados da documentação em inglês e rótulos curtos de documentos internos.
• A memória de tradução fica nos arquivos gerados docs/.i18n/*.tm.jsonl do repositório de publicação.
• Consulte docs/.i18n/README.md.