Write documentation for each command
programarivm opened this issue · 2 comments
The following commands need to be documented with examples:
Documenting a command is a two step process.
- Add a new entry in the mkdocs.yml file
- 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!
Is this issue still being worked on? I'd be interested in helping write documentation and/or editing the existing ones. Let me know!
@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,