OMNI·ONE Docs

Contribuir com a documentação

Estado: política editorial proposta v0.1, sujeita à revisão.

Este portal deve permitir que outras pessoas compreendam, reproduzam e, quando pertinente, contribuam para o conhecimento desenvolvido no OMNI·ONE.

Regras mínimas de publicação

  1. Distinguir explicitamente fato verificado, proposta, hipótese e objetivo futuro.
  2. Referenciar versão e fonte de especificações e procedimentos técnicos.
  3. Descrever pré-requisitos e testes necessários para reproduzir tutoriais.
  4. Fazer revisão técnica e editorial antes de publicar.
  5. Não divulgar credenciais, tokens, dados pessoais ou informação operacional sensível.
  6. Identificar links externos e a situação de disponibilidade de produtos e serviços.
  7. Registrar alterações relevantes e corrigir documentação desatualizada.

Caminho de revisão

Criar uma branch, preparar páginas em Markdown, abrir um pull request, revisar informações e links, executar npm ci, npm test, npm run typecheck e npm run build, e integrar somente após aprovação.

Licenças

A licença de conteúdo e contribuições ainda precisa ser definida. Ser publicamente acessível não equivale, por si só, a licença aberta para redistribuição.