Repository navigation
Debug Panel features have no dedicated docs section in the guides #2536
Description
Describe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePlugins - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdxDescribe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePlugins - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdxDescribe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePlugins - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdxDescribe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePlugins - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdxDescribe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePluginsDescribe the gap
The Debug Panel is one of Wheels' most useful development-mode tools —
it surfaces installed packages, registered packages, environment, request
timings, plugin warnings, and route information directly in the running
app via vendor/wheels/events/onrequestend/debug.cfm. None of this is
documented in the user guides at
web/sites/guides/src/content/docs/v4-0-0-snapshot/.
Expected
A dedicated docs section (likely under
working-with-wheels/debug-panel.mdx or a sibling page) that covers:
- What the Debug Panel is, when it appears, and how to enable/disable it
- Each panel section in turn — what it shows, when it's useful, what
underlying config or state drives it - Screenshots of the panel in a typical dev session
Features to cover (non-exhaustive)
- Environment + Wheels version + CFML engine identification
- Git branch (when in a git working tree)
- Installed packages table
- Available packages table (registry list — recently wired up in fix(view): wire registry-packages list into debug bar Packages tab #2533)
- Failed packages
- Plugins (legacy)
- Warnings — incompatible plugins, version mismatches, mixin collisions
- Routes, settings, request timings (whatever the current
debug.cfmrenders)
Code reference
- Template:
vendor/wheels/events/onrequestend/debug.cfm - Settings:
enableDebug,enablePackagesComponent,enablePluginsComponent,
showIncompatiblePlugins - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdx - Existing precedent:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdx
Activity
wheels-bot commentedon May 10, 2026
Wheels Bot — Triage
Classified as docs-request.
Docs scope
A new page at
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/debug-panel.mdx(the issue suggestsworking-with-wheels/but that directory does not exist;digging-deeper/matches the existing structure and thepackages.mdxprecedent). The page should cover: what the Debug Panel is, when it appears, and how to toggle it viaenableDebug; each rendered section (environment, Wheels version, CFML engine, git branch, installed packages, available packages, failed packages, legacy plugins, warnings, routes, settings, request timings); and the relevant config settings (enableDebug,enablePackagesComponent,enablePluginsComponent,showIncompatiblePlugins). Source of truth isvendor/wheels/events/onrequestend/debug.cfm.Confidence:
highThe deliverable is a single concrete page, the correct path is unambiguous from the existing
digging-deeper/structure, the code reference and settings list are provided in the issue, and writing the page is primarily readingdebug.cfmand translating it to prose — no design decisions required.wheels-bot commentedon May 10, 2026
Wheels Bot — Docs proposed
The Debug Panel guide has been committed to branch `docs/bot-2536-debug-panel-features-have-no-dedicated-docs-sectio`. The workflow's push step will publish the branch after this run; once it is on the remote, the draft PR against `develop` can be opened from that branch.
Pages updated:
Screenshots needed: 7
The following sections in `debug-panel.mdx` contain `{/* screenshot: ... */}` placeholder markers. A human reviewer should capture and replace each one:
A human review is required before merge. Reviewer A and Reviewer B will weigh in shortly.
ci: allow git push in bot-write-docs allowlist (#2537)
wheels-bot commentedon May 10, 2026
Wheels Bot — Docs proposed
Draft PR: #2539
Pages updated:
web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/debug-panel.mdx— new page covering all tabs and panelsweb/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/index.mdx— added Debug Panel card to the section indexCHANGELOG.md— added[Unreleased] > ### DocumentationentryScreenshots needed: 7
The following sections in
debug-panel.mdxcontain{/* screenshot: ... */}placeholder markers. A human reviewer should capture and replace each one:A human review is required before merge. Reviewer A and Reviewer B will weigh in shortly.