Meridian Docs
A documentation platform where every code sample is executed on every deploy.
API reference page generated from the OpenAPI schema
Runnable code sample with a language switcher above it
Search overlay listing matches grouped by documentation section
Problem
Pulseboard’s docs had 340 code samples and no way to know which ones still worked. Support answered the same four questions every week, all of them caused by a snippet that had drifted from the API.
The docs were also a separate deploy from the product, so a breaking change shipped on Monday and the documentation caught up on Thursday.
Approach
Every fenced code block in the MDX is extracted at build time and executed against a live sandbox tenant. A sample that throws fails the build, so a broken snippet cannot reach the site.
The API reference is generated from the same OpenAPI schema the server validates against, which means it cannot describe an endpoint that does not exist.
Docs moved into the product repo. A pull request that changes an endpoint and does not change its documentation gets a failing check.
Result
Documentation-caused support tickets fell 31% in the first quarter and stayed down.
Nineteen broken samples were found by the very first build. Nobody had known.
What changed
down 31%
Docs-caused support tickets
19, on the first build
Broken samples found
3 days → 0
Docs lag behind the API