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

Write a list for the demo in godot-demo-project #1809

Closed
ZX-WT opened this issue Oct 7, 2018 · 4 comments
Closed

Write a list for the demo in godot-demo-project #1809

ZX-WT opened this issue Oct 7, 2018 · 4 comments

Comments

@ZX-WT
Copy link
Contributor

ZX-WT commented Oct 7, 2018

godotengine/godot-demo-projects#280 give me this idea of writing a summary for each demo.

The official demo repo has some simple projects that demonstrate the use of a particular node or feature. But even the user download the demo repo , it is difficult to know what is the focus of a project even a clear name is given to it and find the one he needs.

A list may give them a better idea, the list includes the name of it, the folder, a short summary and most importantly the nodes that it is using. This provide the info for new users what should they open for learning a particular feature.

I even think about a list in order of learning like the rigidbody demo, platformer demo and then pathfinding, so on. But some may not fit in the list.

We can put a link to this list next to the download button for the demo in the official website, this should help new users.

@pwab
Copy link

pwab commented Oct 7, 2018

A list may give them a better idea, the list includes the name of it, the folder, a short summary and most importantly the nodes that it is using. This provide the info for new users what should they open for learning a particular feature.

Great idea. Not sure where to put that list in the docs but there could be a subcategory for demos which could also include explanations (little tutorials) for each demo project.

@aaronfranke
Copy link
Member

Most of the demo projects now have README files in them, which covers the issue of having a description.

It would still be nice to point to the demo projects from within the docs, and perhaps even from the class reference. For example, KinematicBody would link to the Kinematic Character 3D demo.

@Calinou
Copy link
Member

Calinou commented Mar 16, 2020

@aaronfranke Demos could have a description in the application/config/description project setting so it displays when hovering a demo in the project manager.

@aaronfranke
Copy link
Member

@Calinou Good idea, I created godotengine/godot-demo-projects#449 for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants