Open source
Irondocs
Esegue i blocchi di codice della documentazione Markdown come veri test pytest, vitest o jest, così gli esempi non possono disallinearsi dal codice.
schermatairondocs.dev
Irondocsdocumentazione che gira come test
Che cos'è
Un harness di test per la documentazione. Marcate come test un blocco di codice in un file Markdown e viene eseguito come una vera asserzione — con pytest in Python, o vitest o jest in TypeScript — con il nome dell'intestazione più vicina e senza un file di test separato.
Perché esiste
Gli esempi nella documentazione marciscono in silenzio. Un'API cambia, i test vengono aggiornati, e il README continua a mostrare la vecchia firma finché qualcuno la copia e apre una segnalazione. Eseguire gli esempi è l'unico modo per sapere che funzionano ancora.
Il nostro ruolo
Lo manteniamo, e gira sulla nostra stessa documentazione — è così che gli esempi sulle altre pagine di progetto restano onesti.
Su cosa lo costruiamo
Test unitari veloci, HTTP registrato e documentazione che fa fallire la build quando invecchia.
Una sola toolchain in tutti i repository, così spostarsi tra loro non costa nulla.
Contattateci
Raccontateci che cosa volete costruire.
Siamo un piccolo team in Portogallo, con orario di Londra. Un sito, un'app, uno strumento interno o la piattaforma che ci sta dietro — iniziate con una frase sul problema e poi ci pensiamo noi.