[Index] Improve discoverability of the Components documentation#22214
Open
lacatoire wants to merge 1 commit intosymfony:7.4from
Open
[Index] Improve discoverability of the Components documentation#22214lacatoire wants to merge 1 commit intosymfony:7.4from
lacatoire wants to merge 1 commit intosymfony:7.4from
Conversation
Replace the plain text link to the Components page with a proper toctree entry so that it appears in the sidebar navigation alongside Topics, Reference and other sections.
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
2 participants
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.
This replaces the plain text link to the Components page with a proper
toctreeentry, so that Components appear in the sidebar navigation alongside Topics, Reference and other sections.Currently, the Components section on the documentation index is a single line of text (
Read the Components documentation.), making it very easy to miss. As noted in #21282 and this comment, many components (Finder, PropertyAccess, DomCrawler, VarExporter, etc.) are essentially hidden since they are not referenced from the Topics section either.While #21282 asks for a link in the main site navigation (which is outside the scope of this repo), this change improves discoverability within the documentation itself.