From f9618d66224ab05f01b63807a9a9b6084af1f479 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Wed, 28 Jan 2026 00:04:58 +0000 Subject: [PATCH] Add doc-detective-resolver repository documentation --- .../repos/doc-detective-resolver.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/contribute/repos/doc-detective-resolver.md diff --git a/docs/contribute/repos/doc-detective-resolver.md b/docs/contribute/repos/doc-detective-resolver.md new file mode 100644 index 00000000..5504bbb9 --- /dev/null +++ b/docs/contribute/repos/doc-detective-resolver.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 4 +--- + +# `doc-detective-resolver` + +[`doc-detective-resolver`](https://github.com/doc-detective/resolver) is an NPM package that scans documentation for test markup and converts it into executable Doc Detective tests. It's installable via NPM (`npm i doc-detective-resolver`). + +This repo depends on [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. + +## TypeScript codebase + +Source code is in TypeScript (`src/`) and compiles to JavaScript for distribution. Tests run against the compiled output in `dist/`. + +### Building + +```bash +npm run build +``` + +This compiles TypeScript to JavaScript and creates an ESM wrapper for dual module support. Build output goes to `dist/` and includes CommonJS modules (`*.js`), an ESM wrapper (`index.mjs`), and TypeScript declarations (`*.d.ts`). + +### Development workflow + +1. Edit TypeScript files in `src/` +2. Build with `npm run build` +3. Run tests with `npm test` + +Tests run against the compiled output to ensure the published package works correctly.