Skip to content

docs: Add doc-detective-resolver repository documentation#152

Draft
promptless[bot] wants to merge 1 commit intomainfrom
promptless/document-resolver-repo
Draft

docs: Add doc-detective-resolver repository documentation#152
promptless[bot] wants to merge 1 commit intomainfrom
promptless/document-resolver-repo

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Jan 28, 2026

Open this suggestion in Promptless to view citations and reasoning process

Adds a new contributor documentation page for the doc-detective-resolver repository in docs/contribute/repos/. This fills a documentation gap—the resolver repo was the only Doc Detective package without contributor documentation while all other repos (doc-detective, doc-detective-core, doc-detective-common, docker-image, github-action) had pages. The new page covers the package's purpose, TypeScript codebase structure, build process, and development workflow.

Trigger Events

doc-detective/resolver PR #110: feat: migrate to TypeScript

Promptless Research (1 GitHub PR)

Agent Response

I've completed my review of the TypeScript migration PR for the doc-detective/resolver repository.

Summary

The PR migrates the resolver package from JavaScript to TypeScript, adding dual CJS/ESM module support. This is an internal infrastructure change that doesn't affect end-user documentation—the public API remains unchanged.

Documentation Created

While reviewing this PR, I noticed that the doc-detective-resolver repository was the only Doc Detective package without contributor documentation. All other repos (doc-detective, doc-detective-core, doc-detective-common, docker-image, github-action) have documentation pages in docs/contribute/repos/.

I created a new suggestion that adds:

  • New page: docs/contribute/repos/doc-detective-resolver.md

The new documentation covers:

  • What the package does (scans documentation for test markup and converts it into executable tests)
  • Its dependency on doc-detective-common
  • TypeScript codebase structure
  • Build process (npm run build)
  • Development workflow

The page follows the same format and style as the other repository documentation pages, and aligns with the patterns established in the existing suggestion for documenting the doc-detective-common TypeScript migration.


Help us improve Promptless — If this suggestion missed the mark, please share quick feedback.

If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

@@ -0,0 +1,29 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: TypeScript migration PR that documents the build process (npm run build), dual CJS/ESM output structure (dist/*.js, dist/index.mjs, dist/*.d.ts), and development workflow. Package description and purpose from package.json.
View source

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants