Skip to content

Add RenderDoc GPU debugging instructions for Copilot#1645

Open
bghgary wants to merge 2 commits intoBabylonJS:masterfrom
bghgary:add-renderdoc-instructions
Open

Add RenderDoc GPU debugging instructions for Copilot#1645
bghgary wants to merge 2 commits intoBabylonJS:masterfrom
bghgary:add-renderdoc-instructions

Conversation

@bghgary
Copy link
Copy Markdown
Contributor

@bghgary bghgary commented Mar 25, 2026

Add Copilot instruction files for GPU debugging with rdc-cli:

  • copilot-instructions.md: Project-level Copilot configuration
  • renderdoc-gpu-debug.instructions.md: Full GPU debugging workflows
  • rdc-commands-reference.instructions.md: Complete rdc-cli command reference
  • debugging-recipes.instructions.md: Step-by-step debugging recipes

These instructions enable Copilot to assist with GPU frame capture, pipeline state inspection, shader debugging, and visual analysis using rdc-cli (a CLI wrapping RenderDoc's Python API).

Add Copilot instruction files for GPU debugging with rdc-cli:
- copilot-instructions.md: Project-level Copilot configuration
- renderdoc-gpu-debug.instructions.md: Full GPU debugging workflows
- rdc-commands-reference.instructions.md: Complete rdc-cli command reference
- debugging-recipes.instructions.md: Step-by-step debugging recipes

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 25, 2026 05:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds GitHub Copilot instruction markdown files to guide GPU frame capture and analysis workflows using RenderDoc via rdc-cli, intended to help with capture, pipeline/shader inspection, pixel debugging, and frame diffs.

Changes:

  • Added a full RenderDoc GPU debugging workflow guide (rdc open → inspect → rdc close) with common recipes.
  • Added a command quick reference for rdc-cli covering the documented command surface.
  • Added an extended “debugging recipes” document with step-by-step procedures and example output shapes.
  • Added repository-level Copilot instructions entrypoint under .github/.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.

File Description
.github/instructions/renderdoc-gpu-debug.instructions.md Main RenderDoc/rdc-cli workflow guide and debugging playbook.
.github/instructions/rdc-commands-reference.instructions.md Command-by-command reference for rdc-cli flags/args.
.github/instructions/debugging-recipes.instructions.md Longer form troubleshooting recipes with expected output structures.
.github/copilot-instructions.md Project-level Copilot instructions pointing to the GPU debugging docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Remove references to capture_frame.py (doesn't exist in repo)
- Fix Vulkan layer docs reference to point to instructions file
- Simplify session docs (remove undocumented --session flag)
- Fix headless capture options (remove non-existent --interactive flag)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

3 participants