search

godotengine / godot-proposals

Godot Improvement Proposals (GIPs)
MIT License
1.08k stars 69 forks source link

Improve in-engine links that will open in a web browser #9369

Open mieldepoche opened 3 months ago

mieldepoche commented 3 months ago

Describe the project you are working on

stuff

Describe the problem or limitation you are having in your project

image

Sometimes in the integrated docs there are links that when clicked, will open an url in the browser (as opposed to another page of the integrated docs). It's not that clear at a glance.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

image

image

idk if the icon should be colored, it looks correct like that to me.

If this enhancement will not be used often, can it be worked around with a few lines of script?

can't be worked around

Is there a reason why this should be core and not an add-on in the asset library?

core already

dalexeev commented 3 months ago

Note that this PR does not affect [url] tags at all for clarity.

CC @Mickeon

Mickeon commented 3 months ago

Ever since that PR, because the underlines no longer show on every link, the fact that they always show exclusively on these external links would already make them stand out more.

I do like the icon though...

mieldepoche commented 3 months ago

I believe the icon alone is enough to communicate the browser part, but the coloring and dynamic underline make it feel extra obvious, web-browser-like, and pleasant to use. I don't like the fact that the current color is the normal text one, and I don't like the static aspect of it.

Mickeon commented 3 months ago

The current built-in documentation has a very limited colour palette (basically monochrome, between text and accent color) that I wanted to maintain for the time being. There used to be some concern that anything more would've hurt readability.

However, with efforts such as https://github.com/godotengine/godot/pull/89263 and https://github.com/godotengine/godot/pull/89086, there may be more of an encouragement to go ahead and make things more stylistically pleasing. At some point I had hue shifts depending on the linked subject. I do look forward to experiment with it more at some point.