Merge pull request #239 from chesslablab/issue/171-Document-the-stock…

…fish_eval-command Added docs/stockfish-eval.md
chesslablab · Jan 11, 2024 · b4247c7 · b4247c7
2 parents 292d129 + 32585b5
commit b4247c7
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/stockfish-eval.md b/docs/stockfish-eval.md
@@ -0,0 +1,27 @@
+# /stockfish_eval
+
+Returns Stockfish's evaluation for the given position.
+
+| Name | Description | Required |
+| ---- | ----------- | -------- |
+| `fen` | A FEN string. | Yes |
+
+## Usage
+
+### Example
+
+Evaluate C65 — Ruy Lopez: Berlin Defense.
+
+```js
+ws.send('/stockfish_eval "r1bqkb1r/pppp1ppp/2n2n2/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 4 4"');
+```
+
+```text
+{
+  "/stockfish_eval": {
+    "nag": "$10",
+    "meaning": "Equal position",
+    "symbol": "="
+  }
+}
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -17,4 +17,5 @@ pages:
   - /restart: restart.md
   - /inbox: inbox.md
   - /stockfish: stockfish.md
+  - /stockfish_eval: stockfish-eval.md
 theme: readthedocs