Escaping the Curse of Outdated Docs
summary
Documentation is kept as code: docs live in Git, go through reviews, and have CI tests that test code snippets using Vitest and Playwright so broken examples fail the release pipeline. A custom script called snip extracts tagged snippets from tests and renders them into Docusaurus/Starlight pages, removing duplicate source and test drift. Multiple SDKs (Swift, Kotlin, JavaScript, Go) force consolidation, so core logic moves to Rust→WASM/CFFI and releases only proceed when docs pass.
AI-written summary · about
chapters (18)
- 0:00in this talk…
- 0:30escaping the curse of outdated documentation
- 0:45setting up the nursery
- 1:18differences in building styles
- 4:28the impact of outdated documentation
- 4:54Rizèl Scarlett and TBD
- 6:20lessons learned from managing documentation
- 7:38it’s not easy: TBD as an example
- 8:08overview of TBD's SDKs: Web5, TBDex, DAP
- 9:26supporting multiple programming languages
- 9:52who uses it?
- 10:31how do we manage our docs? treat them as code!
- 11:51testing code snippets
- 12:45how it started / how it’s going now: Shnip
- 15:08a quick demo
- 17:23next steps: Rust
- 17:52takeaways
- 19:04audience questions and answers
related talks
44mPushing documentation (so it doesn't hurt anymore)
39mDevelopers Documentation: your hidden strength
35mThe practical implementation of Documentation as Code
45mDocs as Code Fix a poor documentation culture in your organization
41mStop making fool of yourself about documentation
47mDocumentation as code (explained to my dad)
48mUseful and Beautiful Developer Docs and How to Create Them
45mUseful and Beautiful Developer Docs and How to Create Them