godotengine / godot-docs

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

Updating and Improving Documentation for Gridmap Editor #10265

Open Nodragem opened 1 week ago

Nodragem commented 1 week ago

4.4-master-branch

Now that this PR (https://github.com/godotengine/godot/pull/96922) was merged, it is time to write a little bit of documentation on the Gridmap bottom panel, and all the changes that have happened.

I think it will also be a nice opportunity to:

Let me know what you think.

tetrapod00 commented 1 week ago

There's an existing page for this https://docs.godotengine.org/en/stable/tutorials/3d/using_gridmaps.html. Your additions should probably go in that existing page, unless there is a lot of new content, in which case splitting the page into two could make sense. You probably also want to take a look at the Tilemaps page as an example to follow.

clear any confusion on the scope of Gridmap

This should probably go in the existing intro.

give walkthrough the new UI and shortcuts presenting each tools

These should probably either go in Using Gridmaps > Using Gridmap or a new section or subsection below Using Gridmap

give an example of how to organise the scene tree when making a level

This should probably not be a long section. Maybe a .. note:: is best. We should keep the page on Gridmap focused on the tool itself, and avoid too much best practices discussion.

If you end up rewriting the page, you should take the chance to standardize the formatting. Right now the page uses "quotes" for referring to editor UI, you should use Bold to refer to editor UI like buttons or inspector properties, and also you can link to the class reference if you're referring to properties of the GridMap class.

If you'd rather not write the entire new documentation, you could also just start with a rough draft or an outline with the important points to cover, and then work with someone else expand it into a full page. I can help with that if you'd like.

See also https://github.com/godotengine/godot-docs/issues/7808 for an existing issue about the problems with this page. You don't have to fix all of them, but if you're already making changes see if you can address some of them

Nodragem commented 1 week ago

super! thanks for the suggestions, I will do my best.

I was thinking, if there is a need to update the sample project, can I provide my own sample project? it would be using this free asset pack: https://kaylousberg.itch.io/prototype-bits

And it will look like this: Screenshot 2024-06-07 122347 Screenshot 2024-07-26 110209

tetrapod00 commented 1 week ago

Those are CC0 so should be fine to use in a demo. I'm not familiar with the process for updating sample projects, you might to ask in the contributors chat in either the documentation channel or the demo-content channel.

Consider using the default editor editor environment for screenshots you take for the page, rather than the (nicer looking) environment you have set up. For screenshots in the manual, we might want to prioritize matching the default look so readers are not confused that their editor looks different than the screenshots. Again, I'm not sure of the best practice here, a good question to clarify in the contributors chat

Nodragem commented 1 week ago

Good point, I totally forgot I was using a custom theme!