diff --git a/README.md b/README.md index 5719f534..d6805131 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A chess library for PHP. ### Documentation -Read the latest docs [here](https://php-chess.docs.chesslablab.org/). +Read the latest docs [here](https://chesslablab.github.io/php-chess/). ### License diff --git a/docs/chess-tutor.md b/docs/chess-tutor.md index d3edbd41..b1d92feb 100644 --- a/docs/chess-tutor.md +++ b/docs/chess-tutor.md @@ -4,7 +4,7 @@ ✨ Chess beginners often think they can checkmate the opponent's king quickly. However, there are so many different things to consider in order to understand a position. -[Chess\Tutor\FenEvaluation](https://github.com/chesslablab/php-chess/blob/main/tests/unit/Tutor/FenEvaluationTest.php) helps you improve your chess thinking process by evaluating a FEN position in terms of [chess concepts](https://php-chess.docs.chesslablab.org/heuristics/) like in the example below. +[Chess\Tutor\FenEvaluation](https://github.com/chesslablab/php-chess/blob/main/tests/unit/Tutor/FenEvaluationTest.php) helps you improve your chess thinking process by evaluating a FEN position in terms of [chess concepts](https://chesslablab.github.io/php-chess/heuristics/) like in the example below. ```php use Chess\FenToBoardFactory; diff --git a/docs/data-conversion.md b/docs/data-conversion.md index 5c3e5645..812f8972 100644 --- a/docs/data-conversion.md +++ b/docs/data-conversion.md @@ -21,7 +21,7 @@ echo $board->toFen(); r1bqkb1r/pp2pppp/2np1n2/8/3NP3/2N5/PPP2PPP/R1BQKB1R w KQkq - ``` -When a single parameter is passed in the form of a FEN string into the factory create method, it will be assumed that you want to create a classical chess board object. As discussed in the [Home](https://php-chess.docs.chesslablab.org/) section, you may want to check out the self-explanatory tests for this class to learn more about it. The unit tests are the best documentation. They contain hundreds of real examples on how to use the PHP Chess library. +When a single parameter is passed in the form of a FEN string into the factory create method, it will be assumed that you want to create a classical chess board object. As discussed in the [Home](https://chesslablab.github.io/php-chess/) section, you may want to check out the self-explanatory tests for this class to learn more about it. The unit tests are the best documentation. They contain hundreds of real examples on how to use the PHP Chess library. In this example the game history contains two moves only. diff --git a/docs/play-chess.md b/docs/play-chess.md index d2f1348d..49dd8a07 100644 --- a/docs/play-chess.md +++ b/docs/play-chess.md @@ -121,7 +121,7 @@ echo $board->getMovetext(); 1.Rb1 ``` -The FEN is converted to a chess board object as described in the [Data Conversion](https://php-chess.docs.chesslablab.org/data-conversion/#fen-to-board) section. Then Stockfish's depth limit is set to `12` and the skill level to `20`. +The FEN is converted to a chess board object as described in the [Data Conversion](https://chesslablab.github.io/php-chess/data-conversion/#fen-to-board) section. Then Stockfish's depth limit is set to `12` and the skill level to `20`. The same thing goes to starting a game from a particular SAN movetext. As you can see in the example below, [Chess\Play\SanPlay](https://github.com/chesslablab/php-chess/blob/main/tests/unit/Play/SanPlayTest.php) is used for this purpose. diff --git a/docs/read-moves.md b/docs/read-moves.md index 3f173bef..13594f4f 100644 --- a/docs/read-moves.md +++ b/docs/read-moves.md @@ -118,7 +118,7 @@ R N B Q K . . R Every time a move is made, the state of the board changes. -[Chess\Variant\Classical\Board](https://github.com/chesslablab/php-chess/blob/main/tests/unit/Variant/Classical/BoardTest.php) provides you with plenty of methods to interact with a chess board object. It is a quite common use case to query the board state. As discussed in the [Home](https://php-chess.docs.chesslablab.org/) section, you may want to check out the corresponding tests for further details on how to use it. The unit tests are the best documentation. They contain hundreds of real examples on how to use the PHP Chess library. +[Chess\Variant\Classical\Board](https://github.com/chesslablab/php-chess/blob/main/tests/unit/Variant/Classical/BoardTest.php) provides you with plenty of methods to interact with a chess board object. It is a quite common use case to query the board state. As discussed in the [Home](https://chesslablab.github.io/php-chess/) section, you may want to check out the corresponding tests for further details on how to use it. The unit tests are the best documentation. They contain hundreds of real examples on how to use the PHP Chess library. The `isCheck()` method will confirm that the white king is in check after 5.Bb5+ while `isMate()` will confirm that it has not been mated. diff --git a/mkdocs.yml b/mkdocs.yml index dffe4066..07d0a1f5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: PHP Chess -site_url: https://php-chess.docs.chesslablab.org/ +site_url: https://chesslablab.github.io/php-chess/ theme: name: readthedocs nav: