Skip to content

docs: fix stale command signatures and add cbuffer/rt-depth/--gpu coverage#262

Merged
BANANASJIM merged 1 commit into
masterfrom
docs/command-coverage-refresh
Jun 23, 2026
Merged

docs: fix stale command signatures and add cbuffer/rt-depth/--gpu coverage#262
BANANASJIM merged 1 commit into
masterfrom
docs/command-coverage-refresh

Conversation

@BANANASJIM

@BANANASJIM BANANASJIM commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Comprehensive refresh of the hand-written user docs against the current command surface (auto-generated commands.json/commands-quick-ref.md were already fresh; the hand-written docs had drifted).

Fixes

SKILL.md — wrong command signatures (agents execute these verbatim, so they were failing):

  • texture (dropped non-existent --format), assert-count/assert-pixel/assert-image/assert-state, search (dropped --type), shader-replace/shader-restore/shader-build forms, debug pixel EID-first, and all /pipelines VFS paths → /draws/<eid>/pipeline/.
  • Added cbuffer to the export workflow + the rdc doctor duplicate-Vulkan-layer warning note.

Astro site:

  • Removed the dead passes --switches / RT_SWITCHES docs (that flag was removed) from usage.astro + examples.astro.
  • Added cbuffer and rt --depth examples; fixed a literal \n render artifact.
  • remote.astro: documented open --gpu and the localhost127.0.0.1 remote normalization.

README: added cbuffer to Export, completed the remote subcommand list, added cbuffer/rt --depth/--gpu examples.

Every corrected signature was verified against commands.json + source. No auto-generated files touched.

Verification

check-commands / check-replay exit 0 · lint clean · test 3037 passed/6 skipped (93.17%) · docs-build built all 10 pages.

Summary by CodeRabbit

  • Documentation
    • Updated CLI command examples and syntax for export, debugging, and assertion workflows
    • Added multi-GPU replay support documentation with --gpu option
    • Enhanced offline analysis examples with additional export commands
    • Added Vulkan layer configuration warning in installation guide
    • Removed deprecated features from documentation

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 12ceffb2-d7a1-4bfd-8e05-4615aab7eb22

📥 Commits

Reviewing files that changed from the base of the PR and between a8342fd and 904dfcb.

📒 Files selected for processing (6)
  • README.md
  • docs-astro/src/pages/docs/examples.astro
  • docs-astro/src/pages/docs/install.astro
  • docs-astro/src/pages/docs/remote.astro
  • docs-astro/src/pages/docs/usage.astro
  • src/rdc/_skills/SKILL.md

📝 Walkthrough

Walkthrough

Documentation-only update across README.md, three Astro docs pages, and SKILL.md. Adds depth and cbuffer export examples, documents --gpu for multi-GPU replay, expands the Remote subcommand table, adds a duplicate Vulkan layer warning, removes the --switches pass-analysis option, and aligns all SKILL.md command examples with newer CLI argument conventions.

Changes

CLI Documentation and SKILL.md Updates

Layer / File(s) Summary
README quickstart, remote, and commands table
README.md
Adds --depth and cbuffer export examples to quickstart, inserts a --gpu multi-GPU note in the remote section, reorders the VFS row, and expands the Remote subcommand list with setup, status, and disconnect.
Install docs: duplicate Vulkan layer warning
docs-astro/src/pages/docs/install.astro
Adds a warning in the Verification section about multiple VK_LAYER_RENDERDOC_Capture registrations causing non-deterministic loader selection and silent capture timeouts.
Remote docs: --gpu option and localhost normalization
docs-astro/src/pages/docs/remote.astro
Documents --gpu INDEX|NAME|DEVICEID for replay GPU selection in rdc open, and adds notes on --gpu override semantics and localhost-to-127.0.0.1 normalization.
Examples and usage docs: export additions and --switches removal
docs-astro/src/pages/docs/examples.astro, docs-astro/src/pages/docs/usage.astro
Reformats JSON comment lines, expands offline-analysis export commands with depth RT and cbuffer outputs, and removes the rdc passes --switches example from both pages.
SKILL.md: core workflow and common task command updates
src/rdc/_skills/SKILL.md
Updates core workflow VFS/debug/export examples to EID-first conventions, and rewrites pixel debug, shader search, RT export, cbuffer decode, and VFS browse examples to match newer argument signatures.
SKILL.md: CI assertions and shader edit-replay syntax
src/rdc/_skills/SKILL.md
Updates the CI assertion table and script examples to new assert-pixel/assert-count parameter shapes, and rewrites shader edit-replay examples to the stage/ID-oriented flow (shader-build, shader-replace, shader-restore).
SKILL.md: duplicate Vulkan layer troubleshooting
src/rdc/_skills/SKILL.md
Adds a troubleshooting entry for duplicate Vulkan layer registration diagnosed by rdc doctor, with remediation steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • BANANASJIM/rdc-cli#165: Updates the same README.md commands table including the Remote category structure.
  • BANANASJIM/rdc-cli#191: Updates remote.astro with --android replay option in the same rdc open command reference section this PR extends with --gpu.
  • BANANASJIM/rdc-cli#213: Modifies the same src/rdc/_skills/SKILL.md file, adding Remote/Troubleshooting sections that overlap with this PR's SKILL.md revisions.

Suggested labels

Review effort 1/5

🐇 A bunny hops through docs so bright,
GPU flags and cbuffer in sight,
Vulkan layers? No two, just one!
--switches removed, the cleanup is done,
EID-first examples now shine right! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/command-coverage-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@BANANASJIM
BANANASJIM merged commit 0a4daab into master Jun 23, 2026
16 of 17 checks passed
@BANANASJIM
BANANASJIM deleted the docs/command-coverage-refresh branch July 1, 2026 03:50
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