Skip to content

Add 'Learning new features' page. #4258

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

Merged
merged 4 commits into from
Oct 13, 2020

Conversation

willnationsdev
Copy link
Contributor

@willnationsdev willnationsdev commented Oct 12, 2020

Closes #4169

Addresses critiques of #4251 (or at least, tries to). Can end up including both or just this one, either way.

cc @NathanLovato since it'll require your review.

@Calinou Calinou added the content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features label Oct 12, 2020
@NathanLovato
Copy link
Contributor

It's looking good! Do you mind if I edit directly and add a commit to your PR? I'd like to do some small stylistic changes, add one or two pictures... but it's great.

Regarding #4251, it's more that I don't know if it addresses a need as it stands so I'd like other people's feedback on it. I'd at least replace some descriptions by instructions and tips regarding search and navigation.

@willnationsdev
Copy link
Contributor Author

@NathanLovato Yeah, feel free to do whatever you want. As long as what needs to get done gets done, I'm good with you doing whatever. :-)

@NathanLovato
Copy link
Contributor

Leaving this here if you want to put it somewhere else. It's beyond the scope of a page about learning Godot efficiently:

Bug Reports
-----------

If you think you have found a bug but are unsure, then go ahead and open a bug report on `GitHub <https://github.com/godotengine/godot/issues>`. Be sure to check through previous issues to see if you can find a similar one.

If you do, please upvote the post to show that you too want to see the bug fixed. If you have more information or context to add to the bug report, please add a comment to it.

If you do not find any similar past issues, then please follow the template to submit a new bug report.

If you ask in a community platform and someone informs you that it is a bug, then please remember to submit the bug report. Without it, there is little chance the Godot contributors will fix it.

@NathanLovato
Copy link
Contributor

NathanLovato commented Oct 12, 2020

Leaving you some general feedback as I'm editing the page.

Here's a great resource until #4064 gets reviewed and merged: https://v3.vuejs.org/guide/contributing/writing-guide.html#principles

The principles they use to write Vuejs's docs. I recommend looking at some of their docs' pages too. I follow a similar mindset when writing or editing docs. For instance, in the Godot docs, titles can be vague, like Manual, Feature X. You'll see I'm rewriting them to state a problem: Finding new information in the manual, Moving characters with feature X.

@NathanLovato
Copy link
Contributor

Just edited the page and moved it to a new getting_started/introduction section (following #4035, I want to remove or rename step_by_step that lead some contributors to write step-by-step instructions over explanations at times). Adding pics next.

@NathanLovato
Copy link
Contributor

Done! It's ready for review I guess.

Copy link
Contributor Author

@willnationsdev willnationsdev left a comment

Choose a reason for hiding this comment

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

Great edits! Thanks.

@NathanLovato
Copy link
Contributor

Thanks for the review.

@NathanLovato
Copy link
Contributor

Is it good to merge with those changes?

Copy link
Contributor Author

@willnationsdev willnationsdev left a comment

Choose a reason for hiding this comment

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

Looks good to me! Ready to merge I think.

@NathanLovato NathanLovato merged commit 9df5158 into godotengine:master Oct 13, 2020
@NathanLovato
Copy link
Contributor

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Getting Started / Introduction / How to learn Godot most efficiently
3 participants