Skip to content
@doc-detective

Doc Detective

README.md

Doc Detective

Keep your docs in sync with your product. Always.

What's Doc Detective?

Doc Detective is a doc content testing framework that simplifies the process of keeping your docs accurate and up-to-date. You write tests, and Doc Detective runs them directly against your product to ensure your docs match your user experience. Whether it’s a UI-based process or a series of API calls, Doc Detective can help you find doc bugs before your users do.

  • doc-detective: The doc-detective command line interface for creating and running documentation tests.

Additional tools

Component repositories

Doc Detective is built from component parts for re-usability.

  • common: Shared resources for Doc Detective projects.
  • core: The NPM package that powers Doc Detective's testing functionality.
  • resolver: Transform source files into resolved tests.

Pinned Loading

  1. doc-detective doc-detective Public

    Doc Detective is an open-source documentation testing framework that makes it easy to keep your docs accurate and up-to-date.

    JavaScript 107 13

  2. core core Public

    The NPM package that powers Doc Detective's testing functionality.

    JavaScript 9 2

  3. resolver resolver Public

    Transform source files into resolved tests.

    JavaScript 1 1

  4. common common Public

    Shared resources for Doc Detective projects.

    TypeScript 3 1

  5. doc-detective.github.io doc-detective.github.io Public

    Doc Detective docs!

    JavaScript 10 17

  6. github-action github-action Public

    Doc Detective as a GitHub Action

    JavaScript 4 2

Repositories

Showing 10 of 12 repositories
View all repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…