Código abierto
Irondocs
Ejecuta los bloques de código de la documentación en Markdown como pruebas reales de pytest, vitest o jest, para que los ejemplos no se desfasen del código.
capturairondocs.dev
Irondocsdocumentación que se ejecuta como pruebas
Qué es
Un arnés de pruebas para la documentación. Marque un bloque de código de un archivo Markdown como prueba y se ejecuta como una aserción real — con pytest en Python, o vitest o jest en TypeScript — con el nombre del encabezado más cercano y sin un archivo de pruebas aparte.
Por qué existe
Los ejemplos de la documentación se pudren en silencio. Una API cambia, las pruebas se actualizan, y el README sigue enseñando la firma antigua hasta que alguien la copia y abre un bug. Ejecutar los ejemplos es la única forma de saber que siguen funcionando.
Nuestro papel
Lo mantenemos, y funciona sobre nuestra propia documentación — que es como los ejemplos de las otras páginas de proyecto se mantienen honestos.
Sobre qué lo construimos
Pruebas unitarias rápidas, HTTP grabado y documentación que hace fallar la compilación cuando se queda obsoleta.
Una sola cadena de herramientas en todos los repositorios, para que moverse entre ellos no cueste nada.
Ponerse en contacto
Cuéntenos qué necesita construir.
Somos un equipo pequeño en Portugal, en horario de Londres. Un sitio, una aplicación, una herramienta interna, o la plataforma que hay detrás — empiece por una frase sobre el problema y nosotros seguimos desde ahí.