Pular para o conteúdo principal

Manutenção da documentação

Os arquivos da documentação ficam em documentations/, dentro do repositório do sistema.

Executar localmente​

Com Node.js 20 ou superior e npm instalados:

cd documentations
npm ci
npm start

O endereço padrão é http://localhost:3000/.

Editar os textos​

Por enquanto, trabalhamos somente com a versão 1.0. Edite diretamente os arquivos em versioned_docs/version-1.0/:

  • modulos/: documentação dos módulos, organizada por categoria.
  • modulos/sistema/two-factor-authentication.md: guia Two-Factor Authentication, consolidado a partir do README do módulo.
  • introducao.md: apresentação da documentação.
  • manutencao.md: instruções de manutenção deste portal.

A pasta docs/ fica reservada para futuras versões e não é publicada nesta etapa. Não é necessário manter duas cópias sincronizadas. A configuração onlyIncludeVersions: ['1.0'] em docusaurus.config.js limita o portal à versão 1.0.

Crie páginas Markdown com title e sidebar_position no cabeçalho. A navegação lateral é gerada automaticamente; use diretórios para agrupar os textos por assunto. A navegação da versão 1.0 fica em versioned_sidebars/version-1.0-sidebars.json.

Futuras versões​

Quando for decidido iniciar outra versão, a configuração e o conteúdo reservado em docs/ poderão ser preparados a partir da versão 1.0. Até lá, mantenha versions.json com apenas 1.0.

Gerar para publicação​

npm run build
npm run serve

O resultado estático é gerado em build/. Configure DOCS_URL com o domínio de publicação e DOCS_BASE_URL com o caminho público, sempre com barras inicial e final. Por exemplo, use /documentations/ para publicar nesse subdiretório.

Publique o conteúdo de build/ em um servidor de arquivos estáticos. A pasta de fontes não é o diretório público de publicação.