Código aberto
Irondocs
Executa os blocos de código da documentação em Markdown como testes reais de pytest, vitest ou jest, para que os exemplos não se desalinhem do código.
capturairondocs.dev
Irondocsdocumentação que corre como testes
O que é
Um harness de testes para documentação. Marque um bloco de código num ficheiro Markdown como teste e ele corre como uma asserção real — com pytest em Python, ou vitest ou jest em TypeScript — com o nome do título mais próximo e sem ficheiro de testes à parte.
Por que existe
Os exemplos da documentação apodrecem em silêncio. Uma API muda, os testes são atualizados, e o README continua a demonstrar a assinatura antiga até alguém a copiar e abrir um bug. Correr os exemplos é a única forma de saber que ainda funcionam.
O nosso papel
Mantemo-lo, e ele corre sobre a nossa própria documentação — é assim que os exemplos nas outras páginas de projeto se mantêm honestos.
Em que o construímos
Testes unitários rápidos, HTTP gravado, e documentação que faz falhar a compilação quando fica desatualizada.
Uma só cadeia de ferramentas em todos os repositórios, para que mudar entre eles não custe nada.
Entre em contacto
Diga-nos o que precisa de construir.
Somos uma equipa pequena em Portugal, a trabalhar no horário de Londres. Um site, uma aplicação, uma ferramenta interna, ou a plataforma por trás deles — comece por uma frase sobre o problema e nós tratamos do resto.