docs: Document doc-detective-common public API exports

[promptless]

Open this suggestion in Promptless to view citations and reasoning process

Adds documentation for the doc-detective-common package's public API, including the newly exported TypeScript types (Specification, Test, Step, Context, Config, Report) that allow consumers to import canonical types directly instead of maintaining parallel type definitions.

Trigger Events

doc-detective/doc-detective PR #194: Export generated types (Specification, Test, Step, Context, Config, Report) from main entry point

Promptless Research (1 GitHub PR)

• Reviewed doc-detective/doc-detective#194

Agent Response

I've completed the documentation update for PR #194. Here's a summary:

Documentation Changes

Updated file: fern/pages/contribute/repos/doc-detective-common.md

I added a new Public API section to the doc-detective-common package documentation that covers:

1. Functions and utilities - Documents the existing exports (schemas, validate, detectTests)
2. TypeScript types - Documents the 6 newly exported types with a code example and descriptions:
   • Specification - A test specification containing tests and configuration
   • Test - An individual test with steps
   • Step - A single action within a test
   • Context - Browser/platform context for running tests
   • Config - Configuration options
   • Report - Test result report

The documentation includes a TypeScript import example so consumers know how to use these types:

import type { Specification, Test, Step, Context, Config, Report } from 'doc-detective-common';

This update helps TypeScript consumers understand what's available from the package and encourages them to use the canonical types rather than maintaining parallel type definitions that could drift from the schema.

---

Tip: See how your feedback shapes Promptless in Agent Knowledge Base 🧠

[promptless]

Citation: PR #194 adds type-only re-exports in src/common/src/index.ts for 6 core structural types: Specification, Test, Step, Context, Config, Report. These types come from src/common/src/types/generated/ and are now publicly accessible.
View source

[github-actions]

🌿 Preview your docs: https://doc-detective-preview-b5a7c6b9-a130-4562-8fd8-c14c62370741.docs.buildwithfern.com