Updated the docs

chesslablab · Oct 17, 2024 · 017f634 · 017f634
1 parent e4e9042
commit 017f634
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 281 deletions.
diff --git a/docs/result-player.md → docs/opening.md b/docs/result-player.md → docs/opening.md
@@ -1,6 +1,6 @@
-# /result_player
+# /opening
 
-Openings results by player.
+Opening results.
 
 ## `White`
 
@@ -10,6 +10,10 @@ The name of the player with the white pieces.
 
 The name of the player with the black pieces.
 
+## `Event`
+
+The name of the event.
+
 ## `Result`
 
 The result of the game.
@@ -21,12 +25,12 @@ The result of the game.
 ### Example
 
 ```js
-ws.send('/result_player "{\\"White\\":\\"Anand,V\\",\\"Black\\":\\"Kasparov,G\\",\\"Result\\":\\"1-0\\"}"');
+ws.send('/opening "{\\"White\\":\\"Anand,V\\",\\"Black\\":\\"Kasparov,G\\",\\"Event\\":\\"\\",\\"Result\\":\\"1-0\\"}"');
 ```
 
 ```text
 {
-  "/result_player": [
+  "/opening": [
     {
       "ECO": "B96",
       "total": 2

diff --git a/docs/result-event.md b/docs/result-event.md
diff --git a/docs/result.md b/docs/result.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,13 +30,11 @@ nav:
     - Text-based:
       - /annotations_game: annotations-game.md
       - /ranking: ranking.md
-      - /result: result.md
     - Param-based:
       - /autocomplete_black: autocomplete-black.md
       - /autocomplete_event: autocomplete-event.md
       - /autocomplete_white: autocomplete-white.md
-      - /result_event: result-event.md
-      - /result_player: result-player.md
+      - /opening: opening.md
       - /search: search.md
   - Binary:
     - Param-based: