Build a developer tool that checks whether code examples in documentation remain consistent with the supplied source code, API specifications, and supported runtime environment.
Allow users to import Markdown documentation, code snippets, API schemas, package manifests, and configuration files.
Create:
A catalog of code examples and their locations.
A detector for referenced functions, parameters, and endpoints that are absent from the supplied source definitions.
A syntax validation stage for supported languages.
An optional sandbox execution stage for examples that can be tested safely.
A dependency and runtime requirement checker.
A report of examples that are outdated, incomplete, or unverifiable.
A suggested correction workflow with source references.
A CI-compatible machine-readable report.
Clearly distinguish static checks from successful execution. Never claim an example works if it has not been run in a suitable environment. Do not execute untrusted code with unrestricted access to files, networks, or secrets. Include a sample documentation repository with intentional errors and automated tests.
0 Comments