Documentation Format
Standard format for Festi Framework documentation. Use when adding or updating docs.
Event documentation
Complete example
Use this structure when documenting an event. All parts in one place:
### Core::EVENT_ON_AFTER_INIT
This event is triggered after Core initialization and all plugins' `init.php` have run. Use it for logic that depends on the full system being ready.
**Target:** The `Core` instance.
**Listening (`init.php`):**
```php
$core->addEventListener(Core::EVENT_ON_AFTER_INIT, function ($event) {
$core = $event->getTarget();
// your logic
});
```
Variations
Heading: Use the event constant: ### ClassName::CONSTANT_NAME
Custom events (dedicated event classes): Use Event data instead of Target. List getters/setters: getValues() / setValues(array), getPluginContext(), etc. Do not use getTarget() for payload.
Target as array: If the target has keys, list them:
**Target:**
* `store` – reference to the DGS (handlers may mutate)
* `plugin` – plugin instance
When in doubt, mirror Core/Events.md and keep it short.