Docker

Run Doc Gen with Docker

Stable Image Policy

Use a published image to inspect or document an explicitly mounted project.

Commanddocker pull ghcr.io/devalltect00/doc-gen:v1.0.2

Quick Command

docker pull ghcr.io/devalltect00/doc-gen:<tag>

Published Image Tags

Tag	Example	Behavior
Exact	`v1.0.2`	Immutable and recommended for CI or reproducible automation.
Minor	`v1.0`	Moves to the newest stable patch in the 1.0 line.
Major	`v1`	Moves to the newest stable release in the 1.x line.
Latest	`latest`	Moves to the newest stable Doc Gen release.

Pull and verify Doc Gen

bash

docker pull ghcr.io/devalltect00/doc-gen:v1.0.2
docker run --rm ghcr.io/devalltect00/doc-gen:v1.0.2 --help

Build a Local Image

The Make targets pass Doc Gen's reviewed source version into the Docker build. This prevents setuptools-scm from using its legacy fallback when Git metadata is intentionally excluded from the image context.

Build and verify a local production image

bash

make c-build-prod
docker run --rm doc-gen-prod:latest --version

For an explicitly reviewed build, override the detected value with DOC_GEN_BUILD_VERSION=1.0.2. Hosted release images continue to receive their version from the validated release tag.

Choose a Tag Deliberately

Use the exact version for repeatable generation in CI. Use v1.0, v1, or latest only when controlled automatic upgrades are acceptable. Mount only the intended project and use structure generate --dry-run before allowing a generated document to be written.

Related Commands

Commands commonly used together with this command.

Installation and First Workflow

Install Doc Gen and preview generation.

Generate

Generate project-structure documentation safely.