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

docs: Improve documentation at Klondike Tutorial Step 5 #3078

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nickf2k
Copy link

@nickf2k nickf2k commented Mar 14, 2024

Description

This PR for solving the issue #3076

1. What would I do to improve this tutorial:

  • Add missing content, eliminate confusing interruptions, and include omitted code sections.
  • Incorporate images and example animations to illustrate our objectives.
  • Introduce additional sections where necessary (though the final source code remains intact).
  • Provide logical transitions between sections.
  • Address why we need to follow specific approaches and not others.
  • Include links and information about general game development concepts (such as the concept of "seed" in game programming).

2. Contents I will add or modify:

  • The Klondike draw
  • Making cards move
  • Animating a card-flip
  • Model and View
  • Ending and restarting the game

I believe these sections are satisfactory, so I won't make any edits to them. I will begin editing from the section: A New World.

  • Immediately after the Start and restart actions section, I will provide an explanation of the "KlondikeWorld" class. Consequently, the adjustment of the "KlondikeGame" class is merely a necessary step when migrating the onLoad() function to KlondikeWorld, rendering the "A stripped-down KlondikeGame class" section redundant.

  • The section Using a Random Number Generator seed appears reasonable. However, I intend to supplement more references to this definition of "seed." If you have any documents or suggestions on this topic, please provide further information. Otherwise, I will utilize the following link: Link to Reddit.

  • The section Introducing the new KlondikeWorld class was previously covered, hence it will be omitted here. Please note that I will enrich the previous instruction with additional details.

  • Button: I will retain and expand upon this section as it lacks significant information.

  • Anchors and coordinates: This section may be considered supplementary information within the Button section. Therefore, I will incorporate and merge it into the Button section.

  • The deal() method: I will maintain this section in its current position, perhaps making minor sentence edits or none at all.

  • More animations of moves: Similar to the section "The deal() method."

  • A graphics glitch: As above.

  • Winning the game: I find this section quite comprehensive; hence, I may not make any alterations.

  • Ending a game and restarting it: This section lacks crucial details and is rather confusing. I will rewrite it to clarify.

  • Have fun button: This section is well-structured; therefore, I may retain it with minor adjustments if necessary.

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

This PR solve the issue #3076

@nickf2k
Copy link
Author

nickf2k commented Mar 14, 2024

I am still working there. Please feel free to discuss about this PR

@nickf2k nickf2k force-pushed the docs-improve-klondike-step-5 branch from 2e47588 to bf1592a Compare March 20, 2024 17:11
@@ -413,6 +413,141 @@ FlameGame. The new world contains (almost) everything we need to play the game a
re-created during each of the above actions.


### KlondikeWorld class

In Flame, a ```World``` is a type of ```Component``` that can contain other ```Components```,
Copy link
Member

Choose a reason for hiding this comment

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

These should only have a single back-tick, tripple back-ticks are for multi-line code

Copy link
Author

Choose a reason for hiding this comment

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

Sure! Let me change this

@spydon
Copy link
Member

spydon commented May 24, 2024

@nickf2k any update on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants