Skip to content

docs: Update repository documentation for common package monorepo merge #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hawkeyexl merged 1 commit into from
Mar 1, 2026
Merged

docs: Update repository documentation for common package monorepo merge #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions fern/pages/contribute/repos/doc-detective-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
11 changes: 7 additions & 4 deletions fern/pages/contribute/repos/doc-detective.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.