Repository navigation
refactor(docs): document each LibreSign release in its own branch - #130
Merged
Merged
Conversation
Contributor
|
Contributor
Navigable documentation previewThis preview is isolated from production. Documentation for the next release lives in the development branch until it is released. |
This was referenced Nov 9, 2026
Open
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
vitormattos
force-pushed
the
docs/main-native-webhooks-homologated
branch
from
November 10, 2026 15:03
667513e to
de18322
Compare
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objetivo
Substituir a herança de diretórios
versioned/base+versioned/shared.jsonpor uma branch documental completa para cada versão do LibreSign, seguindo o modelo de contribuição do Nextcloud, sem perder URLs, guias, OpenAPI nem controles de publicação. Este PR também publica os guias dos webhooks nativos na documentação de desenvolvimento do LibreSign 16.Como editar a documentação após a mudança
developer_manual/,admin_manual/ouuser_manual/emmain.stableNN, em que NN é a versão do LibreSign, não do Nextcloud... toctree::. Nenhum teste Python por página, nenhum manifesto de caminhos nem duplicação emversioned/16/.Branches já criadas e assinadas: stable13, stable14 e stable15.
Mudanças técnicas
versioning/sources.py: busca somente a branch documental correspondente a cada versão, preserva seu SHA e falha explicitamente caso a fonte estável esteja ausente.versioning/build.py,verify.pyeexternal_contract.py: mantêm a vinculação à OpenAPI exata da aplicação e verificam que o conteúdo documental foi consumido da mesma revisão da branch.versioned/base,versioned/shared.jsone todas as sobreposiçõesversioned/<major>/; redirecionamentos históricos preservados emversioning/legacy-routes.json./_review/16/.CONTRIBUTING.md,AGENTS.mde guia dos mantenedores apresentam um fluxo simples de contribuição. Os cinco guias de webhook e o Event Catalog ficam emmain/developer_manual/webhooks/.Validação
mainatual em quatro commits incrementais assinados, sem squash automático; o SHA da árvore final antes e depois é idêntico. O PR está mergeable, sem conflitos.ee220f1.ee220f1aguarda a presença doversions.jsonexato no site antes de comparar as páginas. O workflow Documentation PR Preview passou no commitee220f1, verificando o conteúdo servido pelo GitHub Pages. A transição de draft para Ready for review acionou uma segunda execução para o mesmo commit, ainda em curso.Ordem de integração dos eventos
Os cinco eventos adicionais descritos no catálogo do LibreSign 16 ainda não existem na
mainda aplicação: a implementação está no LibreSign/libresign #9427, ainda aberto. Isso não deve aparecer como aviso dentro do manual versionado, mas é uma dependência de merge: integre o código dos eventos antes de publicar esta documentação como funcionalidade disponível. A remoção do callback legado é tratada separadamente no #9426.O PR #130 está Ready for review, sem conflitos e com DCO aprovado; a aprovação obrigatória do code owner permanece para o mantenedor.
Acompanhamento das branches protegidas
As branches estáveis têm ruleset que exige PR e aprovação de code owner. Os READMEs e guias de manutenção que ainda descreviam a estrutura antiga foram atualizados em PRs específicos, todos com Sphinx e DCO aprovados: #138 (13), #139 (14) e #140 (15). Esses ajustes devem ser revisados e mergeados depois deste PR, sem contornar a proteção das branches.
Sem merge do PR #130, sem deploy do site de produção e sem merge dos três PRs dependentes.