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

Add refresher tips for how to do tasks, explanations, minor style changes #10500

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

y-almannaee
Copy link

This pull request changes the following things on the "Creating the enemy" page under the "Your first 2D game" tutorial:

  • Explains how to change scenes, reminds the user to save their new Mob scene
  • Adds a tip to remind users how to group a node with its children
  • Explains what the Layer and Mask selections do in the CollisionObject2D
  • Adds a tip to remind users how to add animation sprites
  • Adds a comment for other contributors to update a code section with changes to match the example project
  • Adds a tip to remind users how to connect signals to nodes
  • Adds a note on how users can learn what an unknown function does in the Script Editor
  • Minor style updates, manually wrap lines

Please review some of the additions for verbosity. Thank you!

…nges

This changes the following things:

- Explains how to change scenes, reminds the user to save their new Mob scene

- Adds a tip to remind users how to group a node with its children

- Explains what the Layer and Mask selections do in the CollisionObject2D

- Adds a tip to remind users how to add animation sprites

- Adds a comment for other contributors to update a code section with changes to match the example project

- Adds a tip to remind users how to connect signals to nodes

- Adds a note on how users can learn what an unknown function does in the Script Editor
@AThousandShips AThousandShips added enhancement discussion area:getting started Issues and PRs related to the Getting Started section of the documentation labels Jan 13, 2025
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion none of the tips, notes and reminders in this PR should be added. The best thing for a text tutorial is to make it as short and concise as possible. Adding notes and reminders for things people were already taught how to do in this tutorial, and the introduction and step by step sections of the getting started section (which we explicitly tell people to read first), goes against that. Anyone who needs these reminders should be watching a video tutorial instead so they can always see what someone is clicking on.

Additionally, you should not be adding a note asking other people to update code. For starters if you find something out of date and can't update it yourself you should open an issue. The amount of comments we would have if every out of date part of the docs had one would be huge considering we have over 800 open issues. And two, you already have the code you need to update this, if you think the demo repository code is more correct/works better then you should change it yourself in this PR, we have no restrictions on who can update code examples

@tetrapod00
Copy link
Contributor

I mostly agree with skyace here. In isolation, one or two of these tips might be appropriate additions. In general I tend to favor including small additions and clarifications to these pages, since each addition represents a reader's confusion that they considered worth making a PR for, and is in most cases shared by other readers. But taken all together these changes are too much, for the reasons skyace mentioned.

I think one alternative to consider is to add some more header sections within each Getting Started tutorial page. Then, when a later tutorial needs to reference the content of an earlier tutorial, we could link directly to the header section rather than either vaguely referencing the contents (like we currently do with Don't forget to set the children so that they cannot be selected, like you did with the Player scene), or explicitly listing the steps again as this PR does. That would be a much larger project, though, and is definitely outside the scope of just this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation discussion enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants