Open source
Testdocs
Estrae i blocchi di codice TypeScript dal Markdown e li esegue come test, mantenendo gli esempi allineati al codice.
schermatatestdocs.dev
Testdocsesempi di documentazione eseguibili
Che cos'è
Un'infrastruttura di test per la documentazione. Estrae i blocchi di codice TypeScript dai file Markdown e li esegue come test veri sotto Vitest o Jest, così gli esempi di un README diventano parte della suite di test senza duplicazione tra le due cose.
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
Siti statici e renderizzati dal server che girano vicino all'utente, ed economici da mantenere.
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.