From d428c476ead0f6d41572ca942817b6500d57d4e2 Mon Sep 17 00:00:00 2001 From: Lina Wolf <> Date: Wed, 9 Sep 2026 19:10:43 +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 say in AGENTS.md which validation `make test-docs` runs. Nine of the manuals' AGENTS.md files described it as fail-on-log while their Makefile used --minimal-test, so naming CI as the reference makes the claim checkable rather than repeating a number that silently rots. Assisted-by: Claude Opus 5 Signed-off-by: Lina Wolf --- AGENTS.md | 2 +- Makefile | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 3663a700..df8cdf18 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,7 +14,7 @@ CONTRIBUTING.rst # how to contribute (issues, branching, PRs) ## Commands - `make docs` — render the manual locally with Docker -- `make test-docs` — render in minimal-test 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 ## Rules diff --git a/Makefile b/Makefile index 0dc49439..cf820b3d 100644 --- a/Makefile +++ b/Makefile @@ -3,13 +3,11 @@ help: ## Displays this list of targets with descriptions @echo "The following commands are available:\n" @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' - .PHONY: docs -docs: ## Generate projects docs (from "Documentation" directory) +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