Skip to content

Move debugging into a Debugging and Optimization section, and document the Inspector's Performance tab - #1306

Open
mvaligursky wants to merge 1 commit into
mainfrom
claude/debugging-and-optimization
Open

mvaligursky wants to merge 1 commit into
mainfrom
claude/debugging-and-optimization

Conversation

@mvaligursky

Copy link
Copy Markdown
Contributor

Debugging was a part of Scripting, though its tools, the Inspector above all, cover much more than scripts. This moves it next to the profiling tools and the optimization guides, under one section that says which tool to use for what, and documents the Inspector's Performance tab, new in @playcanvas/inspector 0.4.0.

Changes:

  • The top-level Optimization section becomes Debugging and Optimization, in three groups: Debugging (Console Logging, Browser Dev Tools, Inspector), Profiling (MiniStats, AppStats, Inspector Performance, Editor Profiler, GPU Profiling) and Optimization (the guides). Scripting keeps a Debugging link to it.
  • Its landing page opens with a Which Tool to Use table, from a question to the tool that answers it, followed by the goals of optimizing.
  • The debugging pages move from /user-manual/scripting/debugging/ to /user-manual/debugging/ (en and ja), with their images, redirects from the old URLs, and every link updated. The optimization URLs are unchanged.
  • The Debugging page covers the whole application, not only its scripts, and links Debug Drawing.
  • New Inspector Performance page (en and ja), with screenshots: recording and the charts, the events (hitches and a blocked main thread), the frame timeline, GPU and script timing, loading, recording the start of the application, the app's counters, engine builds and copying the figures.
  • The Inspector page lists the record option and the Performance tab.
  • The engine llms.txt index covers the new debugging section and lists the Inspector and the new page.

Notes:

  • The embedded example keeps the id debug/entity-inspector, which the 2.24 examples keep working after renaming it to debug/inspector; it shows the Performance tab once the 2.24 examples are live.

This branch was successfully deployed

1 active deployment
Preview — 3ea1c350 Deployed Oct 28, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant