Skip to content

docs: restore release-scoped user and admin manuals for 13–15 - #133

Merged
vitormattos merged 11 commits into
mainfrom
docs/restore-stable-user-admin-manuals
Nov 10, 2026
Merged

vitormattos merged 11 commits into
mainfrom
docs/restore-stable-user-admin-manuals

Conversation

@vitormattos

@vitormattos vitormattos commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

Objetivo

Substituir os índices provisórios dos manuais de usuário e administrador nas linhas estáveis 13, 14 e 15 por guias de tarefas que possam ser encontrados e utilizados, sem herdar indiscriminadamente o conteúdo de desenvolvimento (main). Recuperar os destinos estáveis dos links históricos indexados.

Conteúdo

  • Manual de usuário: primeiros passos, solicitação e acompanhamento de assinaturas, assinatura de convites, validação de PDF/UUID, FAQ com ressalvas legais e suporte.
  • Manual de administrador: instalação, verificação de dependências, configuração de certificados, manutenção, backups, segurança e diagnóstico.
  • Índices com toctree visível e links contextuais entre os três públicos, preservando âncoras históricas (main_screen, add_signature, see_signed_file).
  • As oito rotas legadas de artigos dos manuais de usuário/admin passam a ter destinos estáveis da versão 15, em lugar de páginas mutáveis da linha main; os 46 URLs históricos continuam mapeados e não apontam para índices genéricos.
  • CI valida HTML gerado, links internos, contratos OpenAPI, versões, redirecionamentos e SEO. Não existem testes que exijam nomes de páginas, contagem de arquivos RST, comprimento mínimo de textos ou frases editoriais.

Evidência de compatibilidade usada para redigir

As ações comuns foram verificadas contra o código das três releases atualmente pinadas pelo versions.json de produção:

  • LibreSign 13.4.9 / Nextcloud 33: 414ca98fa2e7644cc15f45d0d5ac46d989551491
  • LibreSign 14.2.9 / Nextcloud 34: ebe7b60dffbf80fa7b728647bbbd5304e2cee3e3
  • LibreSign 15.0.12 / Nextcloud 35: 7a08f8822feaea944aab4873e34763629297ca3f

Componentes examinados nas três linhas: src/views/Request.vue, src/views/Validation.vue, src/views/SignPDF/SignPDF.vue, src/views/Settings/Settings.vue, src/components/Request/RequestPicker.vue, src/components/Request/SignerSelect.vue, src/views/Settings/RootCertificateOpenSsl.vue, src/views/Settings/DownloadBinaries.vue e lista/status dos signatários. O texto diferencia configurações opcionais e não anuncia a Policy Workbench como disponível em 13/14.

Verificação e limites

Fora do escopo

Ainda não cobre todas as funcionalidades avançadas específicas de cada release nem uma busca unificada entre manuais. Nenhum deploy ou merge está autorizado por este PR.

Descoberta de conteúdo (adicionado depois da abertura)

  • A página inicial apresenta atalhos por tarefa para a versão estável corrente (primeiros passos, solicitar e acompanhar assinaturas, validação, instalação e integração). Todos os links usam current_stable; o usuário continua podendo escolher versões anteriores.
  • O índice estável de desenvolvedores aponta diretamente para integração e OpenAPI da release, com link explicitamente identificado para o manual de contribuição de main sem tratá-lo como recurso estável.
  • Testes adicionais para rotas dos atalhos, versão selecionada e fixtures da página inicial.
  • Commits incrementais assinados com DCO; acompanhar CI do head atual e não fazer merge sem revisão.

Revisão dos testes (2026-11-09)

  • Removidos os testes que exigiam oito nomes de arquivos, uma lista fixa de atalhos, textos literais, número mínimo de caracteres e âncoras em um RST específico.
  • Removida a regra que exigia correspondência exata entre todos os RST atuais e as 46 URLs legadas, o que impedia adicionar novas páginas. O manifesto das URLs antigas continua preservado e o build ainda valida cada destino real.
  • O fixture do link de preview agora testa apenas a existência e navegação da rota de revisão, sem reproduzir artificialmente todos os links da homepage. A CI completa continua validando todos os links no HTML de produção.
  • O PR permanece sem merge para revisão humana; confirmar a prévia publicada antes de aprovar.

CI de preview — execução validada

  • O workflow compara dinamicamente as páginas HTML geradas, os recursos principais da home e versions.json com o conteúdo servido na URL pública. Não exige nomes fixos de guias, frases ou números de arquivos RST.
  • Documentation PR Preview — aprovado: 228 URLs verificadas por comparação exata com o conteúdo gerado.
  • Documentation — aprovado: Sphinx, OpenAPI, links e multiversão aprovados; DCO aprovado no head 77c56c1.
  • Preview navegável: https://libresign.github.io/site-preview/docs-preview/pr-133/
  • Limitação externa não bloqueante neste PR: o repositório de previews compartilhado retém múltiplos snapshots de PRs já fechados e publicou artefatos de ~1,81 GB, acima da recomendação do GitHub Pages. A coleta de resíduos e a prevenção de novas retenções devem ser tratadas no fluxo do LibreSign/site-preview / LibreSign/site sem tornar este PR de documentação responsável por apagar previews de outro produto.
  • Não realizar merge automático; o PR está pronto para revisão editorial e técnica.

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>
…topics

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>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos marked this pull request as ready for review November 9, 2026 21:01
…yments

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
…tity

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Navigable documentation preview

The preview is isolated from production. Unreleased pages use the
development application contract for review, not a released
stable LibreSign version. Sphinx, links and pinned OpenAPI are checked
in CI; screenshots are not required.

Unreleased pages available for review:

@vitormattos
vitormattos merged commit c8ef43f into main Nov 10, 2026
3 checks passed
@vitormattos
vitormattos deleted the docs/restore-stable-user-admin-manuals branch November 10, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant