This repository was archived by the owner on Sep 13, 2022. It is now read-only.
feat(client): add documentation for the urturn/client on the docs website #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarahannali
reviewed
Aug 3, 2022
| - `getLocalPlayer` | ||
|
|
||
| ## Example of use | ||
| Before getting into an example, it is critical to note the importance of the `makeMove` method. You can think of the method as a bridge between two states of your game, from a frontend perspective. This makes it easier to imagine the game in terms of discrete states when it comes to development work. |
docs/client-docs.md
Outdated
|
|
||
| `old state -> makeMove -> new state` | ||
|
|
||
| In the `checkers` repo, there exists [use](https://github.com/turnbasedgames/checkers/blob/73f0f3127687935d636c13dfb84f137e365087b1/frontend/src/App.jsx#L336) of the `makeMove` method. |
Contributor
There was a problem hiding this comment.
I think we should link to the tictactoe repo instead since its the most basic one / is the template: https://github.com/turnbasedgames/tictactoe/blob/e36ab75d5e9c9a4165b17070971b79dae93585b2/frontend/src/App.jsx#L84
sarahannali
reviewed
Aug 3, 2022
|
|
||
| `old state -> makeMove -> new state` | ||
|
|
||
| In the `checkers` repo, there exists [use](https://github.com/turnbasedgames/tictactoe/blob/e36ab75d5e9c9a4165b17070971b79dae93585b2/frontend/src/App.jsx#L87) of the `makeMove` method. |
Contributor
There was a problem hiding this comment.
and the name
Suggested change
| In the `checkers` repo, there exists [use](https://github.com/turnbasedgames/tictactoe/blob/e36ab75d5e9c9a4165b17070971b79dae93585b2/frontend/src/App.jsx#L87) of the `makeMove` method. | |
| In the `tictactoe` repo, there exists [use](https://github.com/turnbasedgames/tictactoe/blob/e36ab75d5e9c9a4165b17070971b79dae93585b2/frontend/src/App.jsx#L87) of the `makeMove` method. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for the
@urturn/clienton the website