From 7390ff79cc0d83b0b30a2a3dfdf5d46857297480 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Tue, 5 May 2026 20:01:58 +0300 Subject: [PATCH 1/2] Document debug setup --- src/guide/start/workflow.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/guide/start/workflow.md b/src/guide/start/workflow.md index 5201ded5..c8ea7b2a 100644 --- a/src/guide/start/workflow.md +++ b/src/guide/start/workflow.md @@ -22,6 +22,27 @@ In addition to the web application, you can access a console script via `./yii` Use this script to run background and maintenance tasks for the application, which the [Console Application Section](../tutorial/console-applications.md) describes. +## Debugging + +Yii can collect debug data for web requests and expose it through the +[Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/). + +Install the debug API package: + +```shell +composer require yiisoft/yii-debug-api +``` + +Enable debug mode in `.env`: + +```dotenv +APP_DEBUG=true +``` + +The package registers its routes automatically. Start the application and open `/debug` to check that the debug API is +available. Then open [Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/) and set your application URL there. + +Use debug mode for local development. In production, keep `APP_DEBUG=false` and don't expose debug routes publicly. ## Application structure From fa0014240c56dd241a2065f6186b2e86d35b06d3 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Wed, 6 May 2026 01:41:08 +0300 Subject: [PATCH 2/2] Clarify debugger status --- src/guide/start/workflow.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/guide/start/workflow.md b/src/guide/start/workflow.md index c8ea7b2a..1b2c489c 100644 --- a/src/guide/start/workflow.md +++ b/src/guide/start/workflow.md @@ -22,15 +22,16 @@ In addition to the web application, you can access a console script via `./yii` Use this script to run background and maintenance tasks for the application, which the [Console Application Section](../tutorial/console-applications.md) describes. -## Debugging +## Experimental debugger -Yii can collect debug data for web requests and expose it through the -[Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/). +Yii has a debugger that can collect debug data for web requests and expose it through the +[Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/). The debugger is a work in progress. It isn't released as a +stable package, and its API, routes, and setup may change or be deprecated. -Install the debug API package: +To try the current development version, install the debug API package: ```shell -composer require yiisoft/yii-debug-api +composer require yiisoft/yii-debug-api:^3.0@dev ``` Enable debug mode in `.env`: @@ -42,7 +43,8 @@ APP_DEBUG=true The package registers its routes automatically. Start the application and open `/debug` to check that the debug API is available. Then open [Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/) and set your application URL there. -Use debug mode for local development. In production, keep `APP_DEBUG=false` and don't expose debug routes publicly. +> [!CAUTION] +> Use debug mode for local development. In production, keep `APP_DEBUG=false` and don't expose debug routes publicly. ## Application structure