From d2138ebab020cf97f63541b6d65a20a6d3bc2359 Mon Sep 17 00:00:00 2001 From: guvra Date: Thu, 2 Feb 2023 18:01:04 +0100 Subject: [PATCH] Improve documentation --- doc/toolbar.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/doc/toolbar.md b/doc/toolbar.md index fd07f9d..0ce4cd5 100644 --- a/doc/toolbar.md +++ b/doc/toolbar.md @@ -1,27 +1,21 @@ # Toolbar -## Access +## Accessing the Toolbar -On the top of the page, you will see the **Smile ToolBar** button. +At the top of the page, you will see the **Smile ToolBar** button. +You can click on it to display the toolbar. -You can click on it to display the Toolbar: +By default, it displays data about the 5 last executed requests. +The current page is not always the top most element of the list. +The top element is often an ajax request (e.g. magento_pagecache_block_esi). -If the button is **blue**, it means that there is no warning during the current execution. +If the button is **blue**, it means that there is no warning for the select request. +If the button is **orange**, it means that there is at least one warning. -If the button is **orange**, it means that there is at least one warning during the current execution: +For example: ![configuration](images/screenshot-zone-summary.png) -## Navigator - -On the left, you can see the navigator. - -It allows you to navigate into the last X executions. - -You can analyse every ajax call, esi block, ... - -If an execution has a warning, its line will be **orange**. - ## Zones The following zones are available: @@ -41,17 +35,24 @@ You can click on each zone label to see the concerned information. If a zone is **orange**, it means that there is at least one warning in it. -The value in warning will be in **orange**: +For example: ![configuration](images/screenshot-zone-mysql.png) -In some zones, you can display additional information, by clicking on the links **Show xxx (xx rows)** on the top of the zone. +In some zones, you can display additional information, by clicking on the links **Show xxx (xx rows)** at the top of the zone. -it will display a popin with a sortable table. +It will display a modal dialog with a sortable table. -On some tables, you can click on the row to display additional information. +In some tables, you can click on the row to display additional information. For example, in the **mysql queries tables**, you can display the php trace: ![configuration](images/screenshot-table-queries.png) +## Cache + +If full page cache is enabled, cached requests will not be displayed in the toolbar. +Therefore, it is recommended to disable the full page cache when using the debug toolbar. + +If the full page cache engine is properly configured (e.g. Varnish VCL file), it should be possible to disable the full page cache temporarily by enabling the option "Disable Cache" in the console of your browser. + [Back](../README.md)