Write documentation for each command

[jbassagana]

The following commands need to be documented with examples:

• Document the /accept command #147
• Document the /draw command #148
• Document the /resign command #149
• Document the /takeback command #167
• Document the /leave command #168
• Document the /online_games command #169
• Document the /stockfish command #170
• Document the /stockfish_eval command #171
• Document the /inbox command #217
• Document the /rematch command #218

Documenting a command is a two step process.

1. Add a new entry in the mkdocs.yml file
2. Write the corresponding documentation file in the docs folder

The docs will be built using Read the Docs.

---

The examples can be obtained while interacting with the www.chesslablab.com website as described next.

Figure 1. Open Google Chrome developer tools. Click on Play > Play Computer and click on Create Game for command examples.

Figure 2. As chess moves are played, Stockfish's response is displayed on the Network > WS > Messages tab.

Also recently a TCP socket server has been implemented in the chesslablab/chess-server repo for testing purposes.

Figure 3. Run the cli/testing.php script.

Figure 4. Connect to the TCP server via telnet and run commands.

Happy learning!

[stepperpig]

Is this issue still being worked on? I'd be interested in helping write documentation and/or editing the existing ones. Let me know!

[jbassagana]

@stepperpig welcome to ChesslabLab.

Thank you for joining the community, please make sure to read the Contributing Guidelines. This is a collection of issues, please comment on a specific task so that it can be assigned to you.

Happy coding and learning,