Skip to content

Commit

Permalink
Updated the docs on the /tutor_good_pgn command
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Feb 7, 2025
1 parent eb8d629 commit 54255d8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/tutor-good-pgn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# /tutor_good_pgn

Explains the why of a good move in terms of chess concepts.

---

### Usage

#### Example

Starts a classical game to play 1.e4 e5 2.f4 asking the chess tutor for a good move.

```js
ws.send('/start "{\\"variant\\":\\"classical\\",\\"mode\\":\\"analysis\\"}"');
ws.send('/play_lan "{\\"color\\":\\"w\\",\\"lan\\":\\"e2e4\\"}"');
ws.send('/play_lan "{\\"color\\":\\"b\\",\\"lan\\":\\"e7e5\\"}"');
ws.send('/play_lan "{\\"color\\":\\"w\\",\\"lan\\":\\"f2f4\\"}"');
ws.send('/tutor_good_pgn');
```

```text
{
"/tutor_good_pgn": {
"pgn": "c5",
"paragraph": "White has a moderate control of the center. White has a slight space advantage. These pieces are hanging: The rook on a1, the rook on h1, the rook on a8, the rook on h8, the pawn on e4, the pawn on c5. Overall, 3 evaluation features are favoring White."
}
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ nav:
- /start: start.md
- /stockfish: stockfish.md
- /tutor_fen: tutor-fen.md
- /tutor_good_pgn: tutor-good-pgn.md
- binary:
- Parameterized:
- /image: image.md
Expand Down

0 comments on commit 54255d8

Please sign in to comment.