inline-test-injection

To embed test specs as inline comments in Markdown, you provide a JSON or YAML Doc Detective test specification and run the inject utility to semantically map steps into the source file. You can preview changes or apply them directly to update docs in place.

Yes, you can inject Doc Detective test steps into MDX, HTML, AsciiDoc, and XML/DITA files. The skill parses specifications and targets these formats to insert inline comments near related content, keeping test validation close to the documentation source.

Yes, you need Node.js and the Doc Detective tooling installed in your runtime environment to resolve test specs, match steps, and render inline comments. Python3 and npm are also required dependencies for executing the injection process.

The best way to preview inline comment changes is to run the inject utility without the --apply flag. This generates a preview of the semantic test step mappings in your Markdown or MDX files, preserving editorial control before you commit any modifications.

You handle non-standard syntax during test spec injection by using custom configuration options to extend matching patterns. This allows the tool to accurately resolve and map Doc Detective steps into files with unique or non-standard documentation formats.

Inline test comments reduce context switching by keeping Doc Detective specifications close to the related documentation content. By embedding test steps directly in Markdown or MDX sources, you ensure faster validation and keep specs synchronized with the text they verify.