feat: restructure

Author: matoous

.github/workflows/ci.yaml

@@ -34,6 +34,28 @@ jobs:
       - name: Lint
         run: make fmtcheck
 
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@bf6b4fbd49ca58e4608c9c89fba0b8d90bd2a39f # v2.31.0
+        with:
+          php-version: '8.3'
+          coverage: none
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Generate docs
+        run: make docs
+
+      - name: Ensure docs are up to date
+        run: git diff --exit-code -- docs
+
   tests:
     name: Tests (PHP ${{ matrix.php }})
     runs-on: ubuntu-latest

Makefile

@@ -18,6 +18,10 @@ fmt: vendor ## Format code using php-cs-fixer
 fmtcheck: vendor ## Check code formatting
 	PHP_CS_FIXER_IGNORE_ENV=true vendor/bin/php-cs-fixer fix -v --using-cache=no --dry-run 
 
+.PHONY: docs
+docs: vendor ## Generate API reference using phpDocumentor
+	vendor/bin/phpdoc --config=phpdoc.dist.xml
+
 .PHONY: test
 test: vendor ## Run PHPUnit test suite
 	composer test

composer.json

@@ -20,6 +20,11 @@
 			"homepage": "https://github.com/sumup"
 		}
 	],
+	"config": {
+		"platform": {
+			"php": "8.3.0"
+		}
+	},
 	"scripts": {
 		"cs": "php-cs-fixer fix --dry-run --diff",
 		"test": "phpunit"
@@ -29,14 +34,15 @@
 	},
 	"require-dev": {
 		"friendsofphp/php-cs-fixer": "3.89.2",
-		"phpunit/phpunit": "^9.6"
+		"phpunit/phpunit": "^9.6",
+		"phpdocumentor/phpdocumentor": "^3.9"
 	},
 	"suggest": {
 		"guzzlehttp/guzzle": "Allows for implementation of the Guzzle HTTP client"
 	},
 	"autoload": {
 		"psr-4": {
-			"SumUp\\": "src/SumUp/"
+			"SumUp\\": "src/"
 		}
 	},
 	"autoload-dev": {