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

2D movement project can be replaced with a demo #2

Open
YuriSizov opened this issue Apr 25, 2023 · 4 comments
Open

2D movement project can be replaced with a demo #2

YuriSizov opened this issue Apr 25, 2023 · 4 comments
Labels
bug Something isn't working

Comments

@YuriSizov
Copy link
Contributor

It seems that the 2D movement project is used in the article more like a demo than like a starter template. So it should probably be removed and replaced with a demo project of a similar kind.

https://github.com/godotengine/godot-docs-project-starters/tree/master/src/2d_movement_starter
https://docs.godotengine.org/en/latest/tutorials/2d/2d_movement.html

@jynus
Copy link

jynus commented May 22, 2023

Hi, @YuriSizov I would like to help here, but I am not sure I understand the overall philosophy of what's being proposed (beyond just this specific file).

As I understand, the idea is to create here just skeleton projects that readers can use as a starting point and code along the manual/tutorials, is that right?

However, I see a problem, and that is that some people will want to download a final version of those "code along" exercises (because some people will be able to see how it is exactly done, or if they have put a file in the wrong location, etc.

I see 3 options for that:

  • Focus on a skeleton/starter project (I believe this is what is being proposed)
  • Create 2 downloable (or more!) files, a skeleton and a finished project (or potentially, some intermediate steps)
  • Provide the skeleton and build into a demo, that people can download in the demos repo (and we can link to it?)

My guess is that the "demo" was supposed to be used as both a skeleton and a final code by just adding a new scene (but that would need some better explanation)- that could be a 4th approach.

Let me know your thoughts/clear my misunderstandings so maybe I can help with this.

There is a demo accessibility issue, though- github is not a friendly site for those wanting to just download a .zip, and the asset library still offers the 3.X demos (but that could be a separate issue).

@Calinou
Copy link
Member

Calinou commented May 22, 2023

github is not a friendly site for those wanting to just download a .zip

We could have links in each demo's README to download a ZIP containing only that particular folder. This can be done using external services hosted by the community: https://stackoverflow.com/questions/7106012/download-a-single-folder-or-directory-from-a-github-repo

and the asset library still offers the 3.X demos (but that could be a separate issue).

@YuriSizov
Copy link
Contributor Author

As I understand, the idea is to create here just skeleton projects that readers can use as a starting point and code along the manual/tutorials, is that right?

Yes, projects provided in tutorials should serve tutorials they are included in. Complete example projects can still be provided at the end of the article, but must be uploaded as a part of the demo projects repo instead, as that's what they are.

I don't have a prescribed solution here, maybe the article is fine as is and doesn't need a skeleton/starter project. But the point of this issue is that there is no reason to keep a complete project in the docs. If it's complete, then it should be put into demos, or perhaps there already is a demo and this project here is just duplicating it.

@jynus
Copy link

jynus commented May 22, 2023

Thanks for the comments, now that I understood the intention and the core problem, it is ok to not have a definitive answer, I can try to come with a more or less consistent but simple approach that at least makes things better for both the readers -but also results on easier to review updates.

Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants