From 54255d80394fbb9605167315a2e6d2eafa0491a5 Mon Sep 17 00:00:00 2001 From: standard Date: Fri, 7 Feb 2025 12:46:21 +0100 Subject: [PATCH] Updated the docs on the /tutor_good_pgn command --- docs/tutor-good-pgn.md | 28 ++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/tutor-good-pgn.md diff --git a/docs/tutor-good-pgn.md b/docs/tutor-good-pgn.md new file mode 100644 index 00000000..4a691f6d --- /dev/null +++ b/docs/tutor-good-pgn.md @@ -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." + } +} +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 089a6946..04a045e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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