Documentation Generation

Generate docs from handlers

php bin/generate-docs.php --config=./config.php --format=markdown --output=docs/api.md
php bin/generate-docs.php --config=./config.php --format=html --output=docs/api.html
php bin/generate-docs.php --config=./config.php --format=json --output=docs/api.json
php bin/generate-docs.php --config=./config.php --format=openrpc --output=docs/openrpc.json

The docs generator is included in Composer package archives. Repository docs, examples, and the docs-site builder remain repository-only maintenance assets.

Supported formats

Format	Description
`markdown`	Markdown documentation (default)
`html`	Styled HTML page
`json`	Machine-readable JSON
`openrpc`	OpenRPC 1.3.2 specification

Doc metadata sources

Documentation is generated from:

Handler method reflection (types, defaults, required)
PHPDoc tags (@param, @return, @throws, @error)
Procedure descriptor metadata
Runtime request schemas from RpcSchemaProviderInterface when available
Explicit descriptor resultSchema metadata for richer JSON/OpenRPC result contracts
Auto-discovered handler docblock @result-schema tags for richer JSON/OpenRPC result contracts
@requiresAuth / @authenticated annotations
@example-request / @example-response annotations