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

Updating and Improving Documentation for Gridmap Editor #10265

Open
Nodragem opened this issue Nov 14, 2024 · 4 comments
Open

Updating and Improving Documentation for Gridmap Editor #10265

Nodragem opened this issue Nov 14, 2024 · 4 comments
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:editor Related to editor features or workflows topic:3d

Comments

@Nodragem
Copy link

4.4-master-branch

Now that this PR (godotengine/godot#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:

  • give walkthrough the new UI and shortcuts
  • presenting each tools
  • give an example of how to organise the scene tree when making a level (where do I put my interactive scenes?)
  • clear any confusion on the scope of Gridmap (which is to place static background meshes)

Let me know what you think.

@tetrapod00 tetrapod00 added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:3d labels Nov 14, 2024
@tetrapod00
Copy link
Contributor

tetrapod00 commented Nov 15, 2024

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 #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

@tetrapod00 tetrapod00 added the topic:editor Related to editor features or workflows label Nov 15, 2024
@Nodragem
Copy link
Author

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
Copy link
Contributor

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:editor Related to editor features or workflows topic:3d
Projects
None yet
Development

No branches or pull requests

2 participants