Split the framework into declare, compile and run layers

README.md

@@ -153,14 +153,25 @@ class UserCommand
 {
     #[Subcommand(name: 'info', description: 'Get user information')]
     public function info(
-        #[Option(name: 'user', description: 'Target user', required: true)]
+        #[Option(description: 'Target user')]
         User $user
     ): void {
         // Handle user info command
     }
 }
 ```
 
+Whether an option is required comes from whether its parameter has a default, so `$user`
+above is required without saying so.
+
+## Documentation
+
+See [docs/](docs/README.md) — guides for getting started, commands, autocomplete, events and
+translations, plus a reference generated from the source.
+
+Run `composer docs` after changing the public API; the test suite fails if the committed
+documentation no longer matches the code.
+
 ## Contributing
 
 We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Tempcord.

composer.json

@@ -5,9 +5,11 @@
     "type": "library",
     "require": {
         "php": "^8.5",
-        "tempest/console": "^3.18",
         "ragnarok/fenrir": "^1.0",
-        "tempest/core": "^3.18"
+        "tempest/console": "^3.18",
+        "tempest/core": "^3.18",
+        "tempest/event-bus": "^3.18",
+        "tempest/log": "^3.18"
     },
     "license": "MIT",
     "authors": [
@@ -28,7 +30,8 @@
     "scripts": {
         "test": "phpunit",
         "analyse": "phpstan analyse --memory-limit=1G",
-        "cs-fix": "php-cs-fixer fix"
+        "cs-fix": "php-cs-fixer fix",
+        "docs": "php tools/generate-docs.php"
     },
     "config": {
         "sort-packages": true,
@@ -47,7 +50,11 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tempcord\\Tests\\": "tests/"
+            "Tempcord\\Tests\\": "tests/",
+            "Tempcord\\Tools\\": "tools/src/"
         }
+    },
+    "suggest": {
+        "tempest/intl": "Enables name and description translations for commands via #[Command(translationKey: ...)]. Requires ext-intl."
     }
 }

docs/README.md

@@ -0,0 +1,29 @@
+<!-- Generated from the source by `composer docs`. Do not edit by hand. -->
+
+# Tempcord documentation
+
+Build Discord bots with PHP, on top of [Tempest](https://tempestphp.com).
+
+## Guides
+
+- [Getting started](guides/01-getting-started.md)
+- [Commands and options](guides/02-commands.md)
+- [Autocomplete](guides/03-autocomplete.md)
+- [Events](guides/04-events.md)
+- [Translations](guides/05-translations.md)
+- [Plugins](guides/06-plugins.md)
+
+## Reference
+
+Generated from the source, so it describes what the framework actually does.
+
+**Attributes** — [Command](reference/attributes/command.md), [SubcommandGroup](reference/attributes/subcommand-group.md), [Subcommand](reference/attributes/subcommand.md), [Option](reference/attributes/option.md), [Event](reference/attributes/event.md)
+
+**Autocomplete** — [Autocomplete](reference/autocomplete/autocomplete.md), [ArrayAutocomplete](reference/autocomplete/array-autocomplete.md)
+
+**Configuration** — [TempcordConfig](reference/configuration/tempcord-config.md)
+
+**Enums** — [DiscordLocale](reference/enums/discord-locale.md)
+
+**Plugins** — [Plugin](reference/plugins/plugin.md)
+