> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.doc-detective.com/docs/test-docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.doc-detective.com/_mcp/server.

# Test your docs

> A documentation content testing framework that simplifies the process of keeping your docs accurate and up-to-date.

## Docs

- [Test your docs](https://docs.doc-detective.com/docs/test-docs/overview.md): Verify that the procedures in your docs stay correct automatically, whether they walk through a UI, run commands and code, or call an API.
- [Inline tests](https://docs.doc-detective.com/docs/test-docs/inline.md): Define tests directly in your documentation source files using inline comments.
- [Detected tests](https://docs.doc-detective.com/docs/test-docs/detected.md): Automatically generate tests based on your documentation source files.
- [Standalone tests](https://docs.doc-detective.com/docs/test-docs/standalone.md): Define tests in standalone JSON or YAML files for machine-readable test specifications.
- [Fill in fields](https://docs.doc-detective.com/docs/test-docs/fill-fields.md): Run a short test that fills in the first and last name fields in a form.
- [Capture screenshots](https://docs.doc-detective.com/docs/test-docs/capture-screenshots-guide.md): Capture a screenshot of the full viewport, a cropped element, or an element with padding.
- [Detect visual regressions in screenshots](https://docs.doc-detective.com/docs/test-docs/screenshot-visual-regression.md): Compare a screenshot capture against a committed reference image to catch visual drift.
- [Capture screenshots automatically](https://docs.doc-detective.com/docs/test-docs/automatic-screenshots.md): Turn on autoScreenshot to capture an image after every browser-driven step.
- [Annotate screenshots](https://docs.doc-detective.com/docs/test-docs/annotate-screenshots.md): Mark up a screenshot with outlines, arrows, badges, callouts, blurs, and text as part of capturing it.
- [Capture screenshot](https://docs.doc-detective.com/docs/test-docs/capture-screenshots.md): Run a test that fills all fields in a form, then captures a screenshot of the result.
- [Record video](https://docs.doc-detective.com/docs/test-docs/record-video-guide.md): Record a flow as a video, stop it, and choose the right capture engine.
- [Detect visual regressions in recordings](https://docs.doc-detective.com/docs/test-docs/video-visual-regression.md): Use checkpoints and verify guards to catch visual drift and structural problems in a recording.
- [Record video automatically](https://docs.doc-detective.com/docs/test-docs/automatic-recording.md): Turn on autoRecord to record every driver-based context from start to finish.
- [Narrate a recording with annotations](https://docs.doc-detective.com/docs/test-docs/narrate-recordings.md): Use the annotate action to draw on-screen annotations that stay up across a recording.
- [Record video](https://docs.doc-detective.com/docs/test-docs/record-video.md): Run a test that fills all fields in a form, capturing a video of the changes.
- [Test across multiple tabs, windows, and browsers](https://docs.doc-detective.com/docs/test-docs/multiple-tabs-and-windows.md): Open, address, and close browser tabs, windows, and whole browsers in one test with goTo, the surface field, and closeSurface.
- [Test native Windows apps (experimental)](https://docs.doc-detective.com/docs/test-docs/native-windows-apps.md): Open and test a native Windows desktop app with Doc Detective.
- [Test native macOS apps (experimental)](https://docs.doc-detective.com/docs/test-docs/native-macos-apps.md): Open and test a native macOS app with Doc Detective.
- [Test Android apps (experimental)](https://docs.doc-detective.com/docs/test-docs/android-apps.md): Open and test an Android app on an emulator with Doc Detective.
- [Test iOS apps (experimental)](https://docs.doc-detective.com/docs/test-docs/ios-apps.md): Open and test an iOS app on a simulator with Doc Detective.
- [Run shell and code steps](https://docs.doc-detective.com/docs/test-docs/run-shell-and-code.md): Execute the commands and code snippets in your docs, then assert on their exit codes and output.
- [Test HTTP and APIs](https://docs.doc-detective.com/docs/test-docs/http-and-api.md): Issue the API requests in your docs, assert on the responses, and chain calls together with captured values.
- [Generate requests from OpenAPI](https://docs.doc-detective.com/docs/test-docs/generate-tests-from-openapi.md): Drive httpRequest steps from an OpenAPI description, seed them with examples, and override the Authorization header.
- [Integrations](https://docs.doc-detective.com/docs/test-docs/integrations.md)
- [Input formats](https://docs.doc-detective.com/docs/test-docs/input-formats/overview.md): Doc Detective supports multiple documentation formats for defining and detecting tests.
- [Markdown input format](https://docs.doc-detective.com/docs/test-docs/input-formats/markdown.md): Use Doc Detective with Markdown, MDX, and Markdown variants.
- [DITA input format](https://docs.doc-detective.com/docs/test-docs/input-formats/dita.md): Use Doc Detective with DITA XML files and semantic markup.
- [AsciiDoc input format](https://docs.doc-detective.com/docs/test-docs/input-formats/asciidoc.md): Use Doc Detective with AsciiDoc files.
- [HTML input format](https://docs.doc-detective.com/docs/test-docs/input-formats/html.md): Use Doc Detective with HTML files.
- [Custom input formats](https://docs.doc-detective.com/docs/test-docs/input-formats/custom.md): Define custom input formats and markup patterns for your documentation.
- [Contexts](https://docs.doc-detective.com/docs/test-docs/platforms-and-browsers.md): Define the contexts (platform and browser combinations) where tests should run.
- [Heretto integration](https://docs.doc-detective.com/docs/test-docs/heretto.md): Load DITA content directly from your Heretto CCMS for testing.