Move the documentation to the GitHub wiki

.github/workflows/ci.yaml

@@ -17,28 +17,3 @@ jobs:
         uses: ramsey/composer-install@v3
       - name: Run tests
         run: composer test
-  deploy:
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Fetch sources
-        uses: actions/checkout@v4
-      - name: Set up PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          coverage: none
-          extensions: curl, intl, mbstring, simplexml
-          php-version: 8.3
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          cache: pip
-          python-version: 3.12
-      - name: Install dependencies
-        run: |
-          curl --location --output var/castor.phar https://github.com/jolicode/castor/releases/latest/download/castor.linux-amd64.phar
-          pip install --requirement=etc/requirements.txt
-      - name: Deploy documentation
-        run: |
-          php var/castor.phar doc
-          mkdocs gh-deploy --config-file=etc/mkdocs.yaml --force

.gitignore

@@ -1,8 +1,7 @@
 /**/.DS_Store
 /.castor.stub.php
 /.idea/
-/docs/api/
 /etc/http-client.private.env.json
 /var/
 /vendor/
-/www/
+/wiki/

README.md

@@ -5,12 +5,11 @@ Parse and format [LCOV](https://github.com/linux-test-project/lcov) coverage rep
 in [PHP](https://www.php.net).
 
 ## Documentation
-- [User guide](https://docs.belin.io/lcov.php)
-- [API reference](https://docs.belin.io/lcov.php/api)
+- [User guide](https://github.com/cedx/lcov.php/wiki)
+- [Examples](https://github.com/cedx/lcov.php/tree/main/example)
 
 ## Development
 - [Git repository](https://github.com/cedx/lcov.php)
-- [Packagist package](https://packagist.org/packages/cedx/lcov)
 - [Submit an issue](https://github.com/cedx/lcov.php/issues)
 
 ## License

castor.php

@@ -1,7 +1,7 @@
 <?php
 use Castor\Attribute\{AsContext, AsTask};
 use Castor\Context;
-use function Castor\{exit_code, finder, fs, http_download, run, variable};
+use function Castor\{exit_code, finder, fs, run, variable};
 
 #[AsContext(default: true)]
 function context(): Context {
@@ -14,22 +14,6 @@ function clean(): void {
 	fs()->remove("www");
 }
 
-#[AsTask(description: "Builds the documentation")]
-function doc(): void {
-	foreach (["CHANGELOG.md", "LICENSE.md"] as $file) fs()->copy($file, "docs/".mb_strtolower($file));
-
-	$pkg = variable("package");
-	file_put_contents(
-		$file = "etc/phpdoc.xml",
-		preg_replace('/version number="\d+(\.\d+){2}"/', "version number=\"$pkg->version\"", file_get_contents($file))
-	);
-
-	fs()->remove("docs/api");
-	http_download("https://phpdoc.org/phpDocumentor.phar", "var/phpDocumentor.phar");
-	run("php var/phpDocumentor.phar --config=etc/phpdoc.xml");
-	fs()->copy("docs/favicon.ico", "docs/api/images/favicon.ico");
-}
-
 #[AsTask(description: "Performs the static analysis of source code")]
 function lint(): int {
 	return exit_code("php vendor/bin/phpstan analyse --configuration=etc/phpstan.php --memory-limit=256M --verbose");
@@ -41,12 +25,6 @@ function publish(): void {
 	foreach (["tag", "push origin"] as $action) run("git $action v$pkg->version");
 }
 
-#[AsTask(description: "Starts the development server")]
-function serve(): void {
-	doc();
-	run("mkdocs serve --config-file=etc/mkdocs.yaml");
-}
-
 #[AsTask(description: "Runs the test suite")]
 function test(): int {
 	return exit_code("php vendor/bin/phpunit --configuration=etc/phpunit.xml");

composer.json

@@ -40,7 +40,7 @@
 		"test": "phpunit --configuration=etc/phpunit.xml"
 	},
 	"support": {
-		"docs": "https://docs.belin.io/lcov.php",
+		"docs": "https://github.com/cedx/lcov.php/wiki",
 		"issues": "https://github.com/cedx/lcov.php/issues"
 	}
 }