From 2f57a485311de7b2f44e9eced9bd254edca6f1a9 Mon Sep 17 00:00:00 2001 From: programarivm Date: Fri, 13 Oct 2023 00:42:28 +0200 Subject: [PATCH] Improved the docs --- docs/draw.md | 2 +- docs/heuristics.md | 2 +- docs/leave.md | 2 +- docs/rematch.md | 2 +- docs/resign.md | 2 +- docs/start.md | 6 +++--- docs/takeback.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/draw.md b/docs/draw.md index 994522ad..61616686 100644 --- a/docs/draw.md +++ b/docs/draw.md @@ -8,7 +8,7 @@ Allows to offer a draw. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values:

`propose`
`decline`
`accept` | Yes | +| `action` | `propose`
`decline`
`accept` | Yes | ## Usage diff --git a/docs/heuristics.md b/docs/heuristics.md index 99e0e94b..69bd5378 100644 --- a/docs/heuristics.md +++ b/docs/heuristics.md @@ -9,7 +9,7 @@ Returns the heuristics of a chess position. | Name | Description | Required | | ---- | ----------- | -------- | | `fen` | A FEN string. | Yes | -| `variant` | Accepted values:

`960`
`capablanca`
`capablanca-fischer`
`classical` | Yes | +| `variant` | `960`
`capablanca`
`capablanca-fischer`
`classical` | Yes | ## Usage diff --git a/docs/leave.md b/docs/leave.md index 448a4886..80c85f85 100644 --- a/docs/leave.md +++ b/docs/leave.md @@ -8,7 +8,7 @@ Allows to leave a game. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values:

`accept` | Yes | +| `action` | `accept` | Yes | ## Usage diff --git a/docs/rematch.md b/docs/rematch.md index 0204e3c3..a6c6ee2a 100644 --- a/docs/rematch.md +++ b/docs/rematch.md @@ -8,7 +8,7 @@ Allows to offer a rematch. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values:

`propose`
`decline`
`accept` | Yes | +| `action` | `propose`
`decline`
`accept` | Yes | ## Usage diff --git a/docs/resign.md b/docs/resign.md index e970b9d1..3d2fe624 100644 --- a/docs/resign.md +++ b/docs/resign.md @@ -8,7 +8,7 @@ Allows to resign a game. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values:

`accept` | Yes | +| `action` | `accept` | Yes | ## Usage diff --git a/docs/start.md b/docs/start.md index e8d76c60..3b7bdb74 100644 --- a/docs/start.md +++ b/docs/start.md @@ -8,9 +8,9 @@ Starts a new game. | Name | Description | Required | | ---- | ----------- | -------- | -| `variant` | Accepted values:

`960`
`capablanca`
`capablanca-fischer`
`classical` | Yes | -| `mode` | Accepted values:

`fen`
`san`
`play`
`stockfish` | Yes | -| `add` | Additional params.

`fen` (fen mode)
`movetext` (san mode)
`startPos` (san mode)
`settings` (play mode)
`color` (stockfish) | Depends on the mode selected as shown in the following examples. | +| `variant` | `960`
`capablanca`
`capablanca-fischer`
`classical` | Yes | +| `mode` | `fen`
`san`
`play`
`stockfish` | Yes | +| `add` | `fen`
`movetext`
`startPos`
`settings`
`color`
`min`
`increment`
`submode` | Maybe. Depends on the mode selected as shown in the following examples. | ## Usage diff --git a/docs/takeback.md b/docs/takeback.md index 0ce318c5..a9975f4e 100644 --- a/docs/takeback.md +++ b/docs/takeback.md @@ -8,7 +8,7 @@ Allows to take back a move. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values:

`propose`
`decline`
`accept` | Yes | +| `action` | `propose`
`decline`
`accept` | Yes | ## Usage