godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.9k stars 3.19k forks source link

Distinguish between user and contributor documentation #7912

Open kroltan opened 1 year ago

kroltan commented 1 year ago

Your Godot version: 4.1

Issue description: Right now, if you search for "Rider" on the documentation website, you get the page about how to set it up for engine development before the page about using Rider for game development, without any indication about what it is about.

This also appears to be the case in external search engines, though those are not as directly actionable.

Some ideas, in no particular order:

The motivation for this issue was this recent exchange on Mastodon and my previous experience having accidentally bumped into the GDScript Grammar and Debugging and Profiling sections, though those are more obviously not what one would want at first glance.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/contributing/development/configuring_an_ide/rider.html

YuriSizov commented 1 year ago
  • Show the topic structure in search results, so people see that they will be visiting the "Contributing > Engine Development > Configuring and IDE > Rider" page and be able to better judge if that's really the page they mean to read

This is the best option, IMO. It would replicate the information that you already have on the page but for search results.

image