Debug Panel features have no dedicated docs section in the guides

[bpamiri]

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.cfm renders)

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.cfm renders)

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.cfm renders)

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.cfm renders)

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.cfm renders)

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.cfm renders)

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

[wheels-bot]

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 suggests working-with-wheels/ but that directory does not exist; digging-deeper/ matches the existing structure and the packages.mdx precedent). The page should cover: what the Debug Panel is, when it appears, and how to toggle it via enableDebug; 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 is vendor/wheels/events/onrequestend/debug.cfm.

Confidence: high

The 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 reading debug.cfm and translating it to prose — no design decisions required.

[wheels-bot]

Note (edited by maintainer): The idempotency marker line was removed from this comment to allow re-running the docs-request path after PR #2537 fixed the bot's git-push allowlist. The original write-docs run wrote the docs successfully but couldn't open a PR. The orphan branch was deleted; the next workflow_dispatch will re-create it and open a real PR.

---

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:

• `web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/debug-panel.mdx` — new page covering all tabs and panels
• `web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/index.mdx` — added Debug Panel card to the section index
• `CHANGELOG.md` — added `[Unreleased] > ### Documentation` entry

Screenshots needed: 7

The following sections in `debug-panel.mdx` contain `{/* screenshot: ... */}` placeholder markers. A human reviewer should capture and replace each one:

1. The collapsed debug bar across the bottom of a browser window (toolbar overview)
2. Request panel open — key-value table
3. Timing panel open — horizontal bar chart
4. Params panel open — parameters table
5. Environment panel open — Application section
6. Packages section — Installed + Available from registry tables
7. Tools panel open — link-card grid

A human review is required before merge. Reviewer A and Reviewer B will weigh in shortly.

[wheels-bot]

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 panels
• web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/index.mdx — added Debug Panel card to the section index
• CHANGELOG.md — added [Unreleased] > ### Documentation entry

Screenshots needed: 7

The following sections in debug-panel.mdx contain {/* screenshot: ... */} placeholder markers. A human reviewer should capture and replace each one:

1. The collapsed debug bar across the bottom of a browser window (toolbar overview)
2. Request panel open — key-value table
3. Timing panel open — horizontal bar chart
4. Params panel open — parameters table
5. Environment panel open — Application section
6. Packages section — Installed + Available from registry tables
7. Tools panel open — link-card grid

A human review is required before merge. Reviewer A and Reviewer B will weigh in shortly.