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 wants to merge 2 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e76f51
Update contributor docs to reflect Docker consolidation into main repo
promptless[bot] Mar 7, 2026
42e7046
Sync documentation updates
promptless[bot] Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/pages/contribute/repos/doc-detective.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ This monorepo contains:

- 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

@promptless promptless bot Mar 7, 2026

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

- VS Code extension: The Doc Detective extension for Visual Studio Code (located in `src/vscode/`)

Copy link
Contributor Author

@promptless promptless bot Mar 7, 2026

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

This repo depends on [`doc-detective-core`](doc-detective-core) for the primary testing logic.
8 changes: 4 additions & 4 deletions fern/pages/contribute/repos/docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: docker-image (alpha)
title: docker-image (deprecated)
---

> 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

@promptless promptless bot Mar 7, 2026

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


[`docker-image`](https://github.com/doc-detective/docker-image) runs Doc Detective in a container. While Doc Detective can run on most machines as-is, this Docker image simplifies installation and running Doc Detective on machines without Node.js or with heightened security requirements.
The Docker image simplifies installation and running Doc Detective on machines without Node.js or with heightened security requirements.

## What's included

Expand All @@ -16,4 +16,4 @@ The Docker image includes:
- **DITA-OT**: DITA Open Toolkit for DITA content transformation
- **Java Runtime**: Required for DITA-OT operations

This repo depends on [`doc-detective`](doc-detective) for performing the tests.
To contribute to Docker image development, see the [`doc-detective`](doc-detective) repository.