diff --git a/fern/pages/contribute/repos/doc-detective-common.md b/fern/pages/contribute/repos/doc-detective-common.md index 39844d2..d850a23 100644 --- a/fern/pages/contribute/repos/doc-detective-common.md +++ b/fern/pages/contribute/repos/doc-detective-common.md @@ -2,6 +2,8 @@ title: doc-detective-common --- -[`doc-detective-common`](https://github.com/doc-detective/doc-detective-common) is an NPM package that contains shared schemas and logic used across Doc Detective repos. It's installable via NPM (`npm i doc-detective-common`). This package contains the JSON schemas that define each test action. +[`doc-detective-common`](https://github.com/doc-detective/doc-detective/tree/main/src/common) is an NPM package that contains shared schemas and logic used across Doc Detective repos, including the JSON schemas that define each test action. It's installable via NPM (`npm i doc-detective-common`). -This repo doesn't depend on any other Doc Detective repos. +The source code lives in the [`doc-detective`](https://github.com/doc-detective/doc-detective) monorepo under `src/common/`, but the package is still published independently to NPM. + +This package doesn't depend on any other Doc Detective packages. diff --git a/fern/pages/contribute/repos/doc-detective.md b/fern/pages/contribute/repos/doc-detective.md index 76e98bc..96f5065 100644 --- a/fern/pages/contribute/repos/doc-detective.md +++ b/fern/pages/contribute/repos/doc-detective.md @@ -2,8 +2,11 @@ title: "doc-detective" --- -The most common entrypoint for most users, [`doc-detective`](https://github.com/doc-detective/doc-detective) is an NPM-based CLI tool that performs tests. It's installable via NPM (`npm i -g doc-detective`) and directly runnable without installation via NPX (`npx doc-detective`). +[`doc-detective`](https://github.com/doc-detective/doc-detective) is an NPM-based CLI tool that performs tests. It's installable via NPM (`npm i -g doc-detective`) and directly runnable without installation via NPX (`npx doc-detective`). -This repo depends on -- [`doc-detective-core`](doc-detective-core) for the primary testing logic. -- [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. +This monorepo contains: + +- The main CLI tool +- [`doc-detective-common`](doc-detective-common): JSON schema definitions, schema validation logic, and path resolution logic (located in `src/common/`) + +This repo depends on [`doc-detective-core`](doc-detective-core) for the primary testing logic.