Skip to content

Commit 45d5a66

Browse files
Update repository documentation for common package monorepo merge (#14)
Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com>
1 parent dd0fc38 commit 45d5a66

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

fern/pages/contribute/repos/doc-detective-common.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: doc-detective-common
33
---
44

5-
[`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.
5+
[`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`).
66

7-
This repo doesn't depend on any other Doc Detective repos.
7+
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.
8+
9+
This package doesn't depend on any other Doc Detective packages.

fern/pages/contribute/repos/doc-detective.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
title: "doc-detective"
33
---
44

5-
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`).
5+
[`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`).
66

7-
This repo depends on
8-
- [`doc-detective-core`](doc-detective-core) for the primary testing logic.
9-
- [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic.
7+
This monorepo contains:
8+
9+
- The main CLI tool
10+
- [`doc-detective-common`](doc-detective-common): JSON schema definitions, schema validation logic, and path resolution logic (located in `src/common/`)
11+
12+
This repo depends on [`doc-detective-core`](doc-detective-core) for the primary testing logic.

0 commit comments

Comments
 (0)