📄️ doc-detective
The most common entrypoint for most users, 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-core
doc-detective-core is an NPM package that contains config and test logic and actually runs tests. It's installable via NPM (npm i doc-detective-core). This package contains the logic for performing each test action.
📄️ doc-detective-common
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.github.io
doc-detective.github.io are the docs you're reading right now. They're built with Docusaurus and hosted on GitHub Pages.
📄️ github-action
github-action runs Doc Detective in GitHub workflows. While Doc Detective can run in any CI/CD environment, this GitHub Action simplifies the process of running Doc Detective in GitHub workflows, provides a results object that can be used in subsequent steps, and offers handy features like creating GitHub issues for failed tests.
📄️ docker-image (alpha)
This repo is in alpha. It's not ready for production use.