[TASK] Overhaul text roles reference page - #550
Merged
Conversation
The page was a two-line summary plus a tabbed snippet dump with no explanation of what each role does or when to use it. Give :abbr:, :path:, :file:, and :issue: their own entries with rendered examples, and add a callout on the backslash-escaping gotcha (`\Vendor\Ext\Class` silently drops its backslashes; :file:/:php:/:php-short: are exceptions). Point to the pages that already cover :guilabel:/:kbd:, :composer:/:t3ext:, :t3src:, and the code roles instead of duplicating them here. Cross-reference the backslash callout from InlineCode.rst's existing plain-literal example, and reword CodingGuidelines.rst's GUI section to lead with "use :guilabel: for any visible label" instead of only covering click-path separators, adding a single-label example to match. Not verified with the Docker render pipeline: this environment has no network access to resolve docs.typo3.org's intersphinx inventory. Assisted-by: Claude Sonnet 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 page was a two-line summary plus a tabbed snippet dump with no
explanation of what each role does or when to use it. Give :abbr:,
:path:, :file:, and :issue: their own entries with rendered examples,
and add a callout on the backslash-escaping gotcha (
\Vendor\Ext\Classsilently drops its backslashes; :file:/:php:/:php-short: are
exceptions). Point to the pages that already cover :guilabel:/:kbd:,
:composer:/:t3ext:, :t3src:, and the code roles instead of duplicating
them here.
Cross-reference the backslash callout from InlineCode.rst's existing
plain-literal example, and reword CodingGuidelines.rst's GUI section to
lead with "use :guilabel: for any visible label" instead of only
covering click-path separators, adding a single-label example to match.
Not verified with the Docker render pipeline: this environment has no
network access to resolve docs.typo3.org's intersphinx inventory.
Assisted-by: Claude Sonnet 5 noreply@anthropic.com
Signed-off-by: Lina Wolf