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 new Introduction to 2D page #9621

Merged
merged 1 commit into from
Dec 1, 2024
Merged

Conversation

vgezer
Copy link
Contributor

@vgezer vgezer commented Jul 18, 2024

This one adds a "introduction to 2D" page to the documentation which guides the user through the various elements of the UI.

Similar to my other PR: #9481, but this time completely from scratch since I feel that it is missing.

@AThousandShips AThousandShips added enhancement content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.1 cherrypick:4.2 and removed area:getting started Issues and PRs related to the Getting Started section of the documentation labels Jul 18, 2024
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

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

Some immediate grammar and factual issues, will go over this again after these have been fixed to work on the general wording

tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
@vgezer
Copy link
Contributor Author

vgezer commented Jul 21, 2024

Some immediate grammar and factual issues, will go over this again after these have been fixed to work on the general wording

Thanks for the effort!

@vgezer vgezer force-pushed the intro2d branch 2 times, most recently from d7fa2dd to e123740 Compare July 30, 2024 13:19
@AThousandShips
Copy link
Member

Will do a final pass over this today or this weekend

Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

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

Might benefit from some tweaks and polish down the line but with these fixes it should be good to go for my part

tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

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

This looks really good. I think a couple things need changes but I could also see merging this as-is, honestly.

gameplay mechanics, Godot provides a comprehensive set of tools and resources to support
your game development journey. So, get ready to embark on an adventure filled with endless
possibilities and let your imagination soar as you dive into the wonderful realm of 2D game
development with Godot!
Copy link
Contributor

Choose a reason for hiding this comment

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

The tone of this intro feels a little bit out of place here. It feels a lot more suited to the Getting Started or Introduction section, like it's trying to sell me on Godot in general. For the Manual section, we assume that the reader is at least vaguely aware of what Godot is and what it can do, and focus on grounded and technical information.

Whether you're a seasoned developer or just starting out, Godot offers a friendly and intuitive environment to bring your game ideas to life.

I feel like if someone is already in the 2D Intro section, they don't need this kind of persuasive argument.

With its powerful yet accessible features, you'll have the freedom to unleash your creativity and create captivating gaming experiences.

Which features? This paragraph or a paragraph after it seem like a good place to mention the 2D features that Godot is actually really good at, tilemaps, particles, or the 2d lighting system.

So, get ready to embark on an adventure filled with endless possibilities and let your imagination soar as you dive into the wonderful realm of 2D game development with Godot!

This line felt especially out-of-place compared to the rest of this page.

I would try to make the intro a little more concise, maybe list some actual features, and make the tone a bit more grounded. I know this is rather vague feedback, so if you're not sure what to change I can write a revision of the paragraph as a starting point.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another shot.


.. tip:: If you would like to get an introduction to 3D, see :ref:`doc_introduction_to_3d`.

2D workspace
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that it's not completely clear whether the preferred term is:

  • "2D Workspace", as used here and in some other places in the docs
  • "2D main screen", or "2D Editor", as used in the editor itself.

Godot_v4 4-dev4_win64_rezKl8J8lA

I'd be very happy using the terms "Workspaces" and "2D Workspace", but be aware we are setting some precedent here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this then fine? 2D Workspace?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, this is fine as-is, you don't need to make changes.

I'm in favor of calling these workspaces. I just wanted to point out that it's a bit of an open discussion, and let anyone else comment if they cared.

tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
@tetrapod00 tetrapod00 added cherrypick:4.3 topic:2d topic:editor Related to editor features or workflows and removed cherrypick:4.1 cherrypick:4.2 labels Nov 21, 2024
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

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

If the suggestions are applied this looks great to me!

I read through the whole page and checked that the tools and hotkeys are mostly accurate, though it's possible I missed something.

tutorials/2d/introduction_to_2d.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

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

LGTM. Squashing the commits would be nice, if you can.

@tetrapod00 tetrapod00 changed the title A new intro to 2d content, similar to 3d Add new Introduction to 2D page Dec 1, 2024
@tetrapod00 tetrapod00 merged commit 518db5f into godotengine:master Dec 1, 2024
1 check passed
@tetrapod00
Copy link
Contributor

Thank you, great work!

@mhilbrunner
Copy link
Member

Cherry-picked to 4.3 in #10363.

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 content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features enhancement topic:editor Related to editor features or workflows topic:2d
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants