Skip to content

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

Merged
hawkeyexl merged 1 commit intomainfrom
promptless/update-repo-docs-for-common-merge
Mar 1, 2026
Merged

docs: Update repository documentation for common package monorepo merge#14
hawkeyexl merged 1 commit intomainfrom
promptless/update-repo-docs-for-common-merge

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Feb 27, 2026

Open this suggestion in Promptless to view citations and reasoning process

Updates the contributor documentation to reflect that doc-detective-common is now part of the doc-detective monorepo. Changes include:

  • Updated doc-detective-common.md with the new GitHub link pointing to src/common/ in the monorepo, and clarified that the npm package is still published independently
  • Updated doc-detective.md to describe it as a monorepo containing both the CLI tool and the common package

Trigger Events

doc-detective/doc-detective PR #175: Merge `common` into the `doc-detective` repo

Promptless Research (1 GitHub PR)

Agent Response

I've completed the documentation updates for PR #175. Here's a summary:

Documentation Suggestion Created

Title: Update repository documentation for common package monorepo merge

Changes Made

1. fern/pages/contribute/repos/doc-detective-common.md

  • Updated the GitHub link to point to src/common/ in the monorepo instead of the standalone repository
  • Added clarification that the source code now lives in the doc-detective monorepo
  • Noted that the npm package is still published independently

2. fern/pages/contribute/repos/doc-detective.md

  • Updated to describe doc-detective as a monorepo
  • Listed the contents: the main CLI tool and doc-detective-common (in src/common/)
  • Clarified that it depends on doc-detective-core for testing logic

Files Not Changed (No Updates Needed)

  • doc-detective-core.md - Correctly references the npm package dependency
  • doc-detective.github.io.md - Correctly references the npm package dependency

These pages reference doc-detective-common as an npm package dependency, which is still accurate since the package will continue to be published independently to npm.


The suggestion is ready for your review when PR #175 is merged. The documentation will reflect that the common package source code now lives within the main monorepo while still being available as a standalone npm package.


Tip: Create additional Docs Collections to keep multiple repositories in sync 📚

@github-actions
Copy link

@promptless promptless bot marked this pull request as ready for review February 28, 2026 19:02
@promptless
Copy link
Contributor Author

promptless bot commented Mar 1, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@hawkeyexl hawkeyexl merged commit 45d5a66 into main Mar 1, 2026
1 check passed
@hawkeyexl hawkeyexl deleted the promptless/update-repo-docs-for-common-merge branch March 1, 2026 03:17
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.

1 participant