From 2dac46a4d7bb729c441ae305da33abecc37eea1d Mon Sep 17 00:00:00 2001 From: Lina Wolf <> Date: Wed, 9 Sep 2026 19:17:15 +0200 Subject: [PATCH] [TASK] Align the Makefile with the other documentation manuals The Makefiles across the documentation manuals had drifted apart: the strict rendering target was named docs-test in one manual and test-docs in the others, some ran --fail-on-log while their own CI ran --minimal-test, two had lost `make help` to space indentation, and several help descriptions were copy-paste leftovers from unrelated targets. They are being unified on one shared block, so the same command means the same thing in every manual. This manual already used the agreed target names and flag, so only the shared block's wording and spacing change here. Also correct AGENTS.md, which described `make test-docs` as rendering in fail-on-log mode while the Makefile used --minimal-test. Assisted-by: Claude Opus 5 Signed-off-by: Lina Wolf --- AGENTS.md | 2 +- Makefile | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2a6c4a6..91873bb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -10,7 +10,7 @@ CONTRIBUTING.md # how to contribute ## Commands - `make docs` — render the manual locally with Docker -- `make test-docs` — render in fail-on-log mode; use this to validate any change before committing +- `make test-docs` — render in minimal-test mode (the same validation CI runs); use this to validate any change before committing - `pre-commit run --all-files` — apply the whitespace hooks (`trailing-whitespace`, `end-of-file-fixer`) configured in `.pre-commit-config.yaml`; `pre-commit install` wires them into `git commit` diff --git a/Makefile b/Makefile index 8738015..cf820b3 100644 --- a/Makefile +++ b/Makefile @@ -6,11 +6,9 @@ help: ## Displays this list of targets with descriptions .PHONY: docs docs: ## Generate projects documentation (from "Documentation" directory) mkdir -p Documentation-GENERATED-temp - docker run --user $(shell id -u):$(shell id -g) --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation .PHONY: test-docs test-docs: ## Test the documentation rendering mkdir -p Documentation-GENERATED-temp - docker run --user $(shell id -u):$(shell id -g) --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test