Class reference: Add self-links to methods, properties, etc. #91537
Conversation
This file contains 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
|
Nice improvement! I'd like if a link icon 🔗 could be used instead, I think it's more commonly understood nowadays |
I would also make the text/icon a bit larger so it's easier to click/tap, or at least give it some padding to its clickable area with a custom CSS class. |
rburing
force-pushed
the
doc_classref_self_links
branch
from
477f5b9 to
1f85213
Compare
|
The CSS part needs to be done on the Edit: Done. |
rburing
force-pushed
the
doc_classref_self_links
branch
from
1f85213 to
40becfc
Compare
rburing
force-pushed
the
doc_classref_self_links
branch
from
40becfc to
b27c7ec
Compare
rburing
force-pushed
the
doc_classref_self_links
branch
from
b27c7ec to
b280bc0
Compare
AThousandShips
approved these changes
May 26, 2024
Calinou
approved these changes
May 26, 2024
There was a problem hiding this comment.
Tested locally (together with godotengine/godot-docs#9324), it works as expected.
simplescreenrecorder-2024-05-26_20.08.03.mp4
|
Thanks! |
36 tasks
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.
Have you ever wanted to link someone to a specific place in the class reference? You can find the links to specific methods, properties, etc. in the tables at the top of the page. But what if you find the right place by Ctrl+F or by scrolling? Are you going to scroll all the way back up just to get the link? No! No more of this 🙂
Get what you want directly from where you are: the little 🔗 has the link that can be clicked and/or copied.
Ideally, as a follow-up someone would update the CSS on
godot-docsto make the 🔗 appear only when the parent element is hovered, to reduce visual clutter (as is standard).The feature is inspired by the SageMath documentation.