Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve appearance of external links in built-in docs #99480

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Nov 20, 2024

Closes godotengine/godot-proposals#9369

This PR makes the external links in the built-in class reference:

  • Display with an "external link" icon
  • Coloured differently than surrounding text
  • Without outline unless hovered on
  • With a tooltip containing the link

I'm unconvinced on the actual color, though. See also a RocketChat thread. The gist of it is that, I feel like the excessive accent colour brings too much attention to external links, and the icon exists too. Links to the built-in class reference are more important in the editor and should be more notable, as well.

Normal Link Color Saturated Link Color
thumb-Clipboard - November 20, 2024 8_08 PM thumb-Clipboard - November 20, 2024 8_13 PM
Clipboard - November 20, 2024 8_08 PM Clipboard - November 20, 2024 8_14 PM

It's also currently not possible to hide the hint tag's underline individually. Hence the dotted underline on these links.

@Mickeon Mickeon added this to the 4.x milestone Nov 20, 2024
@Mickeon Mickeon requested a review from a team November 20, 2024 19:33
@Mickeon Mickeon requested a review from a team as a code owner November 20, 2024 19:33
@tetrapod00
Copy link
Contributor

I think the bikeshed should be normal link colored.

@Mickeon
Copy link
Contributor Author

Mickeon commented Nov 20, 2024

Updated the PR to also reduce code duplication.

@Mickeon Mickeon force-pushed the doc-help-external-link-icon branch from 1285f93 to 6c675d4 Compare November 20, 2024 21:12
@Mickeon Mickeon requested a review from dalexeev November 20, 2024 21:12
Copy link
Member

@dalexeev dalexeev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me. Note: I haven't tested this.

@akien-mga akien-mga modified the milestones: 4.x, 4.4 Nov 28, 2024
@adamscott
Copy link
Member

Why the dotted underline for the links? (not related with this PR)

@Mickeon
Copy link
Contributor Author

Mickeon commented Nov 28, 2024

It's because of the hint tag which is required for the URL tooltip (unless #99481 is implemented)

@akien-mga
Copy link
Member

Ah right, then let's wait for #99481 to be merged first.

@Mickeon Mickeon force-pushed the doc-help-external-link-icon branch from 6c675d4 to b22bb4d Compare December 2, 2024 16:13
@Mickeon
Copy link
Contributor Author

Mickeon commented Dec 2, 2024

Rebased to use #99481 instead.
image

@Repiteo Repiteo merged commit 1080cd9 into godotengine:master Dec 3, 2024
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Dec 3, 2024

Thanks!

@Mickeon Mickeon deleted the doc-help-external-link-icon branch December 3, 2024 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve in-engine links that will open in a web browser
6 participants