From 580ae8cb9d5acbe2bb0b95c35052d59be5972057 Mon Sep 17 00:00:00 2001 From: Lina Wolf <> Date: Wed, 9 Sep 2026 19:17:15 +0200 Subject: [PATCH] [TASK] Fix make help and align the Makefile with the other 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. The help recipe was indented with spaces instead of a tab, so make never treated it as a recipe: `make help` printed nothing and exited claiming there was nothing to do. The rest of the file is the shared block's wording and spacing. 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 | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ccd6a27..7259681 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 912dde8..cf820b3 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ .PHONY: help 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}' + @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 documentation (from "Documentation" directory)