Improve Klondike tutorial

Open
#2,917 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
dart, flutter
Domain
documentation

Research direction

Locate the Klondike tutorial and review parts 4, Gameplay, and 5, Additional features, against the complete code shown at the end of each part. Check where the instructions, Run and Code buttons, and warnings are unclear; done means the tutorial can be followed with clearer step boundaries and functional results.

Written by the indexing model from the issue text.

Description

enhancement

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

Dominant language
Dart
Stars
10.8k
Forks
1.1k
Avg merge
2d 4h
Merged PRs (30d)
61

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from flame-engine/flame

All issues in flame-engine/flame

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.