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

Improve Klondike tutorial #2917

Open
spydon opened this issue Dec 14, 2023 · 2 comments
Open

Improve Klondike tutorial #2917

spydon opened this issue Dec 14, 2023 · 2 comments

Comments

@spydon
Copy link
Member

spydon commented Dec 14, 2023

What could be improved

Feedback on the Klondike tutorial from moluderu on Discord:

I tried to compile my feedback on the tutorial I nearly finished. It took me about 12-15 hours, I didn't really count.
Right now, if I follow the tutorial exactly as it's written, I end up with an application that doesn't work at all. It's missing pieces and it's full of errors. With the full code at the end of each part, I was able to improve my code to bring it up to standard, but it's essential to do so and this button isn't really highlighted in the tutorial. I think it would be a good idea to use the "Run" and "Code" buttons more often throughout the tutorial.
If you do as I do, you'll end up with clean, functional code after all.
A few small warnings about deprecated stuff like "event.delta" or ".forEach" but, on the whole, it works well.
Overall, the tutorial would benefit from being more injunctive: being clearer about "you MUST do this" or "it's ALREADY been done".
To be a little more precise, I'd have to say it's well written, but there are a few areas that need a bit of work.

In part 4.Gameplay, there's a lack of detail, but it's an advanced stage of the tutorial, so it's not a problem - it just helps to see if you've followed the instructions correctly.
On the other hand, in the last part, 5.Additionnal features, there are quite a few things that are difficult to follow with the large blocks of text and code. The author seems to assume that we have the complete code in front of us at the same time and can directly see what he has written. But the complete code is at the very end of the page and I have to say that I'd rather do things myself than read code comments. This part gave me trouble and I find the rest of the tutorial much better. Sorry for the author, I don't mean to be rude, I'm trying to give constructive criticism.
I've got as far as the "A New World" part for now and it's getting really difficult for me to continue. I'm finding it hard to move on at the moment, I don't seem to understand anything any more. I think I'll go through the documentation a bit and try a few things for fun before coming back to this.

Why should this be improved

To make it an easier time for our users to learn Flame.

Any risks?

No.

More information

@spydon
Copy link
Member Author

spydon commented Dec 19, 2023

@ianliu is this something you'd be interested in doing?

@spydon
Copy link
Member Author

spydon commented Dec 19, 2023

Oops sorry, wrong Ian. Of course meant @IanWadham

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

1 participant