Merge pull request #285 from chesslablab/issue/268-Document-the-tutor…

…_fen-command Documented the /tutor_fen command
chesslablab · May 22, 2024 · 482b011 · 482b011
2 parents 6a8b3b7 + 7b45d22
commit 482b011
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/docs/tutor-fen.md b/docs/tutor-fen.md
@@ -0,0 +1,23 @@
+# /tutor_fen
+
+Explains a FEN position in terms of chess concepts.
+
+| Name | Description | Required |
+| ---- | ----------- | -------- |
+| `fen` | A FEN string. | Yes |
+| `variant` | `960`<br/>`capablanca`<br/>`capablanca-fischer`<br/>`classical` | Yes |
+
+## Usage
+
+### Example
+
+```js
+ws.send('/start classical fen');
+ws.send('/tutor_fen "rnbqkb1r/p1pp1ppp/1p2pn2/8/2PP4/2N2N2/PP2PPPP/R1BQKB1R b KQkq -" classical');
+```
+
+```text
+{
+  "/tutor_fen": "White is totally controlling the center. White has a slight space advantage. Overall, 2 heuristic evaluation features are favoring White while 0 are favoring Black."
+}
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,6 +9,7 @@ nav:
     - /legal: legal.md
     - /play_lan: play-lan.md
     - /heuristics: heuristics.md
+    - /tutor_fen: tutor-fen.md
     - /undo: undo.md
     - /accept: accept.md
     - /takeback: takeback.md