Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the /stockfish command #170

Closed
Tracked by #172
programarivm opened this issue Sep 10, 2023 · 1 comment · Fixed by #238
Closed
Tracked by #172

Document the /stockfish command #170

programarivm opened this issue Sep 10, 2023 · 1 comment · Fixed by #238
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@programarivm
Copy link
Member

Document the /stockfish command with examples.

Happy learning!

@programarivm programarivm added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Sep 10, 2023
@programarivm
Copy link
Member Author

programarivm commented Sep 15, 2023

It 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

Then, the docs will be built using Read the Docs.

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

figure_02
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_03
Figure 3. Run the cli/testing.php script.

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

Happy learning!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
2 participants