From 572872b6ac0157c49000167aeaa79aa31ee7a72a Mon Sep 17 00:00:00 2001 From: programarivm Date: Fri, 13 Oct 2023 00:02:46 +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 8b30bc4b..302936a2 100644 --- a/docs/draw.md +++ b/docs/draw.md @@ -8,7 +8,7 @@ Allows to offer a draw. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values are `propose`, `decline` and `accept`. | Yes | +| `action` | Accepted values:

| Yes | ## Usage diff --git a/docs/heuristics.md b/docs/heuristics.md index 0a26417b..d0522e54 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 are `960`, `capablanca` and `classical`. | Yes | +| `variant` | Accepted values:

| Yes | ## Usage diff --git a/docs/leave.md b/docs/leave.md index 5de99d63..ec7d02df 100644 --- a/docs/leave.md +++ b/docs/leave.md @@ -8,7 +8,7 @@ Allows to leave a game. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values are `accept`. | Yes | +| `action` | Accepted values:

| Yes | ## Usage diff --git a/docs/rematch.md b/docs/rematch.md index 5301dbc2..0f2a5e51 100644 --- a/docs/rematch.md +++ b/docs/rematch.md @@ -8,7 +8,7 @@ Allows to offer a rematch. | Name | Description | Required | | ---- | ----------- | -------- | -| `action` | Accepted values are `propose`, `decline` and `accept`. | Yes | +| `action` | Accepted values:

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

| Yes | ## Usage diff --git a/docs/start.md b/docs/start.md index e1dea41d..0c1e414a 100644 --- a/docs/start.md +++ b/docs/start.md @@ -8,9 +8,9 @@ Starts a new game. | Name | Description | Required | | ---- | ----------- | -------- | -| `variant` | Accepted values are `960`, `capablanca` and `classical`. | Yes | -| `mode` | Accepted values are `fen`, `san`, `play` and `stockfish`. | Yes | -| `add` | Additional params. `color` (stockfish mode), `fen` (fen mode), `movetext` (san mode), `settings` (play mode) and `startPos` (san mode). | Maybe, depends on the mode selected as shown in the following examples. | +| `variant` | Accepted values:

| Yes | +| `mode` | Accepted values:

| Yes | +| `add` | Additional params.

| Depends on the mode selected as shown in the following examples. | ## Usage diff --git a/docs/takeback.md b/docs/takeback.md index 34e723db..fc1c112e 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 are `propose`, `decline` and `accept`. | Yes | +| `action` | Accepted values:

| Yes | ## Usage