Estratégia de Versionamento da Documentação

Para garantir que desenvolvedores e usuários possam acessar a documentação correspondente à versão do Node que estão utilizando, o PAEBIRU adota um sistema de Versionamento por Subdiretórios.

Categorização de Versões

O PAEBIRU utiliza sufixos semânticos para organizar a maturidade da documentação:

1. Camada Stable (Estável):

   • Versões ≥ 0.1.0 sem sufixos.
   • URL: /docs/stable/ ou /docs/v0.1.0/.

2. Camada Testing (Testes):

   • Versões com sufixos -alpha, -beta ou -gamma.
   • Exemplo: v0.1.0-beta.1.
   • Foco: Validação de novas funcionalidades por early adopters.

3. Camada Dev / Experimental:

   • Versões com sufixos -dev ou data no formato -YYYYMMDD.
   • Versões < 0.1.0 (independente de sufixo).
   • Exemplo: v0.2.0-dev ou v0.1.0-20260525.
   • Foco: Desenvolvimento ativo, alta volatilidade.

Política de Estabilidade

O PAEBIRU adota uma política rigorosa para a marcação stable:

1. Versões < 0.1.0: São consideradas experimentais/alpha. A documentação pode mudar drasticamente e não há garantia de retrocompatibilidade.
2. Versões ≥ 0.1.0: Entram no ciclo de estabilidade. O link /docs/stable/ sempre apontará para a versão minor mais alta dentro desta faixa que tenha sido ratificada pelo DAO.

Estrutura de URLs

A documentação publicada segue a estrutura:

• paebiru.org/docs/main/ — Versão de desenvolvimento (branch principal).
• paebiru.org/docs/stable/ — Versão estável mais recente (disponível apenas para versões ≥ 0.1.0).
• paebiru.org/docs/vX.Y.Z/ — Versão específica (tag).

Automação (CI/CD)

O pipeline de CI (.github/workflows/docs.yml) automatiza este processo:

• Atualiza a pasta docs/main/ em cada push para a branch main.
• Cria uma nova pasta docs/vX.Y.Z/ em cada nova tag gerada.
• Atualiza o redirecionamento de docs/stable/ para a tag estável mais recente (conforme a política acima).