Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.

docs: Update contributor docs to reflect Docker consolidation into main repo#21

Closed
promptless[bot] wants to merge 2 commits intomainfrom
promptless/update-docker-contributor-docs-consolidation
Closed

docs: Update contributor docs to reflect Docker consolidation into main repo#21
promptless[bot] wants to merge 2 commits intomainfrom
promptless/update-docker-contributor-docs-consolidation

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 7, 2026

Open this suggestion in Promptless to view citations and reasoning process

Updates the contributor documentation to reflect that Docker image development has been consolidated from the separate docker-image repository into the main doc-detective repository under src/container/.

Changes:

  • Marks the docker-image repo page as deprecated and points contributors to the main repo
  • Updates the doc-detective repo page to include container configurations in the list of monorepo contents

Trigger Events

doc-detective/doc-detective PR #191: Merge dkcker configs

Promptless Research (1 GitHub PR)

Agent Response

I've completed my analysis and created a documentation suggestion for this PR.

Summary

PR #191 consolidates Docker image development from the separate docker-image repository into the main doc-detective repository under src/container/. This is primarily an infrastructure change that doesn't affect end users (the Docker image still works the same way), but it does impact contributors who want to work on the Docker images.

Documentation Updates

I created a suggestion that updates the contributor documentation to reflect this consolidation:

Changes made:

  1. fern/pages/contribute/repos/docker-image.md - Updated the title from "(alpha)" to "(deprecated)" and added explanation that Docker image development is now in the main doc-detective repository under src/container/

  2. fern/pages/contribute/repos/doc-detective.md - Added "Container configurations: Dockerfiles and build scripts for the official Docker images (located in src/container/)" to the list of what the monorepo contains

No changes needed for:

  • User-facing Docker documentation (installation, usage) - the Docker image still works the same way
  • local-development.mdx - Docker references there are for Dev Containers (docs site development), not the Doc Detective Docker image

You can review the suggestion at: https://app.gopromptless.ai/suggestions/4721fb65-2adf-4d3c-b24c-f2664b8b9f64


Tip: Sort by Shortest Review in the Dashboard to find quick wins ⚡

---

> This repo is in alpha. It's not ready for production use.
[`docker-image`](https://github.com/doc-detective/docker-image) is a Docker image that runs Doc Detective in a container. This repository is deprecated and archived—Docker image development is now in the main [`doc-detective`](doc-detective) repository under `src/container/`.
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: PR #191 consolidates Docker image development into the main doc-detective repo under src/container/. The PR adds linux.Dockerfile, windows.Dockerfile, and build scripts, replacing the separate docker-image repository.
View source


- The main CLI tool
- [`doc-detective-common`](doc-detective-common): JSON schema definitions, schema validation logic, and path resolution logic (located in `src/common/`)
- Container configurations: Dockerfiles and build scripts for the official Docker images (located in `src/container/`)
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: PR #191 adds src/container/ directory containing linux.Dockerfile, windows.Dockerfile, and scripts/build.js for building the official Docker images.
View source

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

@promptless promptless bot marked this pull request as ready for review March 7, 2026 19:35
@promptless
Copy link
Contributor Author

promptless bot commented Mar 7, 2026

I've added new changes to address this GitHub PR in commit 42e7046

- The main CLI tool
- [`doc-detective-common`](doc-detective-common): JSON schema definitions, schema validation logic, and path resolution logic (located in `src/common/`)
- Container configurations: Dockerfiles and build scripts for the official Docker images (located in `src/container/`)

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: Added VS Code extension entry based on PR #192 which merges the extension from doc-detective/vscode repo into src/vscode/ in the main monorepo. The extension provides real-time test detection, sidebar integration, and syntax highlighting for Doc Detective tests in VS Code.
View source

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants