[TASK] Align the Makefile with the other documentation manuals - #558
Merged
Conversation
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 <noreply@anthropic.com> Signed-off-by: Lina Wolf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 helpto space indentation, and several helpdescriptions 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-docsruns. Nine of themanuals' 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 noreply@anthropic.com
Signed-off-by: Lina Wolf