Skip to content

Commit

Permalink
Wording
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Nov 12, 2024
1 parent cce17cd commit 8f7441c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Whether it is the `data` service, the `game` service, the `binary` service or the `auth` service, all commands fall into three broad categories:

- Basic commands have no parameters.
- Action commands expect one parameter of type string.
- Parameterized commands expect a JavaScript object parameter.
- **Basic** commands have no parameters.
- **Action** commands expect one parameter of type string.
- **Parameterized** commands expect a JavaScript object parameter.

Probably the easiest way to get familiar with the chess commands is by reading the WebSocket messages sent back and forth between the web browser and the chess server as you interact with a web app. To do this, you may want to use the [website](https://github.com/chesslablab/website) as shown in the example below.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit/)
[![Contributors](https://img.shields.io/github/contributors/chesslablab/chess-server)](https://github.com/chesslablab/chess-server/graphs/contributors)

PHP Chess Server is an asynchronous PHP server that provides services of data and chess functionality to play online over a WebSocket connection.
PHP Chess Server is an asynchronous PHP server that provides chess services over a WebSocket connection.

| Port | Service Name | Description |
| ---- | ------------ | ----------- |
Expand Down
16 changes: 8 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@ site_url: https://chesslablab.github.io/chess-server/
nav:
- Getting Started: getting-started.md
- data:
- Basic commands:
- Basic:
- /annotations_game: annotations-game.md
- /ranking: ranking.md
- Parameterized commands:
- Parameterized:
- /autocomplete_black: autocomplete-black.md
- /autocomplete_event: autocomplete-event.md
- /autocomplete_white: autocomplete-white.md
- /opening: opening.md
- /search: search.md
- game:
- Basic commands:
- Basic:
- /eval_names: eval-names.md
- /online_games: online-games.md
- /undo: undo.md
- Action commands:
- Action:
- /draw: draw.md
- /rematch: rematch.md
- /takeback: takeback.md
- Parameterized commands:
- Parameterized:
- /accept: accept.md
- /heuristic: heuristic.md
- /leave: leave.md
Expand All @@ -35,12 +35,12 @@ nav:
- /stockfish: stockfish.md
- /tutor_fen: tutor-fen.md
- binary:
- Parameterized commands:
- Parameterized:
- /image: image.md
- auth:
- Basic commands:
- Basic:
- /totp_signup: totp-signup.md
- Parameterized commands:
- Parameterized:
- /totp_refresh: totp-refresh.md
- /totp_signin: totp-signin.md

Expand Down

0 comments on commit 8f7441c

Please sign in to comment.