Repository navigation
[TASK] Give every reference a link text and check it - #426
Merged
Merged
Conversation
A hundred and twenty references showed the title of their target instead of a text of their own, which in a guide that sends the reader from step to step reads badly: "Please make sure that you read the Commit Message rules for TYPO3 CMS in the Appendix", or a list item that is a whole headline. The style guide asks for a text that fits the sentence, see https://docs.typo3.org/permalink/h2document:link-text. Each of them now carries one: the target's title where it is a phrase, a shortened form where it is a headline. Seven of them were written as ":ref:`<anchor>`" with an empty label, which shows the title as well. guides.xml switches the check on, see https://docs.typo3.org/permalink/h2document:settings-guides-check-link-text, so a reference without a link text now fails "make test-docs". 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
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.
A hundred and twenty references showed the title of their target
instead of a text of their own, which in a guide that sends the reader
from step to step reads badly: "Please make sure that you read the
Commit Message rules for TYPO3 CMS in the Appendix", or a list item
that is a whole headline. The style guide asks for a text that fits the
sentence, see https://docs.typo3.org/permalink/h2document:link-text.
Each of them now carries one: the target's title where it is a phrase,
a shortened form where it is a headline. Seven of them were written as
":ref:
<anchor>" with an empty label, which shows the title as well.guides.xml switches the check on, see
https://docs.typo3.org/permalink/h2document:settings-guides-check-link-text,
so a reference without a link text now fails "make test-docs".
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf