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