Skip to content

Fechar as pendências da documentação: changelog da quebra e verificador de links no gate #124

Closed

Description

@mariolucasdev

Duas pontas soltas do trabalho de documentação.

1. A quebra do README não está no CHANGELOG

A seção [Não lançado] registra o trabalho de CI do #112, mas não a quebra do README em docs/ (#114) — e essa é a mudança visível para quem usa: link externo para âncora do README antigo deixou de funcionar.

Faltam também, do mesmo PR: a coluna de assinatura de webhook que a matriz não tinha, o bloco de código nunca fechado que fazia o GitHub renderizar da Rede à Efí invertido, e o link quebrado do SUPPORT.md.

2. O verificador de links só existe fora do repositório

O script que provou que a quebra não deixou link quebrado rodou do scratchpad da sessão. A documentação agora são 17 arquivos com link relativo entre eles, e link relativo quebra em silêncio: markdown não reclama, e o GitHub só mostra 404 para quem clicar.

Portar para PHP (.github/scripts/check-links.php, ao lado do smoke.php), expor como composer test:links, somar ao composer test e acrescentar um passo no job de qualidade do CI.

O que ele confere, para cada link que não é http(s)/mailto/tel:

  • o arquivo apontado existe;
  • quando o link tem #âncora, algum título daquele arquivo gera essa âncora pela regra do GitHub.

Um detalhe que não é opcional: título dentro de bloco de código não conta como título. Foi exatamente assim que o fence não fechado da Cielo passou meses escondido, levando dez links do sumário com ele — um verificador que ignorasse as cercas teria dito que estava tudo bem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions