Contributor Documentation Updates #8

MDDBULLDOGG · 2025-12-03T22:58:57Z

Update contributor documentation for easier onboarding of new open-source devs:

Updated linked resources to include useful NVIDIA resources and remove deprecated resources
Adjusted click-through for debugging guide to not require navigation through PyCharm setup
Clarified debugging extension installation instructions to correctly include required launch of lightspeed.app.trex_dev.bat

Summary by CodeRabbit

Documentation
- Added an inline video overview to the Getting Started guide for the Omniverse Kit SDK
- Replaced the Learn USD link with an OpenUSD Intro resource
- Clarified repository structure with explicit namespace labels for key components
- Noted an automated Contributor License Agreement prompt in the PR flow
- Split and updated debugging docs; revised VS Code extension/setup instructions and added a standalone Debugging Guide entry

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Remove non-maintained links Add useful getting started documentation Clarify debugging guide

github-actions · 2025-12-03T22:59:10Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

coderabbitai · 2025-12-03T22:59:15Z

Walkthrough

Documentation updates: CONTRIBUTING.md now references the Omniverse Kit SDK, adds an inline extension-development video, clarifies repository namespace labels for Lightspeed and Flux, adds an automated PR/CLA prompt note, and reorganizes Additional Documentation; DEBUGGING_GUIDE.md updates VS Code debug extension enablement to use lightspeed.app.trex_dev.bat and Window → Extensions instructions and refines the attach workflow prose.

Changes

Cohort / File(s)	Change Summary
Documentation updates `docs_dev/CONTRIBUTING.md`, `docs_dev/DEBUGGING_GUIDE.md`	Reworded Getting Started to use Omniverse Kit SDK and added an inline extension-development video; replaced USD learning links with OpenUSD Intro; clarified repository namespaces (Lightspeed as `lightspeed.trex.`, Flux as `omni.flux.`); added automated Contributor License Agreement prompt in PR workflow; split and renamed IDE/debug entries and updated VS Code debug extension enablement to use `lightspeed.app.trex_dev.bat` with Window → Extensions guidance; minor prose/formatting adjustments in Remote Attach example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Review focus:
- docs_dev/CONTRIBUTING.md: SDK naming, namespace labels, links, PR/CLA wording, and video embed.
- docs_dev/DEBUGGING_GUIDE.md: correct lightspeed.app.trex_dev.bat path, Window → Extensions steps, and the Remote Attach example formatting.

Poem

🐇 I hopped through lines of text and changed a name,

Pushed a tiny video and lit a namespace flame,
A polite PR gate now asks for trust,
VS Code wakes with a link at first thrust,
— carrots for docs, a rabbit's small claim 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Contributor Documentation Updates' accurately reflects the main changes, which involve updates to contributor-facing documentation files (CONTRIBUTING.md and DEBUGGING_GUIDE.md) to improve onboarding and clarify debugging setup.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 134f3cc and b8ffc0a.

📒 Files selected for processing (1)

docs_dev/CONTRIBUTING.md (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs_dev/CONTRIBUTING.md

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

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 and usage tips.}

coderabbitai

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs_dev/DEBUGGING_GUIDE.md (1)
36-37: Clarify backtick placement in multi-line sentence.

The backtick at the end of line 36 creates awkward formatting. Consider restructuring to improve readability.
-For example for VSCode or Cursor, we already have setup `.vscode/launch.json`, otherwise you can create your own with a`
-`Python: Remote Attach` config like this and run it to attach to the server:
+For example for VSCode or Cursor, we already have setup `.vscode/launch.json`; otherwise you can create your own with a `Python: Remote Attach` config like this and run it to attach to the server:

📜 Review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b0c1a16 and 11e672f.

📒 Files selected for processing (2)

docs_dev/CONTRIBUTING.md (2 hunks)
docs_dev/DEBUGGING_GUIDE.md (1 hunks)

🔇 Additional comments (6)

docs_dev/DEBUGGING_GUIDE.md (1)

23-30: Verify debugging instructions and updated workflow.

The changes correctly clarify that users should run lightspeed.app.trex_dev.bat before enabling the VS Code debug extension via the GUI, aligning with the PR objective. The workflow appears sound and provides clearer setup guidance than before.

docs_dev/CONTRIBUTING.md (5)

25-26: Repository structure naming clarification is helpful.

Adding naming convention context (lightspeed.trex., omni.flux.) provides clear identifiers for developers navigating the codebase and improves the developer experience.

28-29: Verify relative path reference to extensions directory.

The relative path ../source/extensions assumes the docs are being read from docs_dev/ context. Confirm this path is correct for the intended documentation viewer/platform.

73-74: Documentation reorganization improves navigation.

Separating "Using Pycharm IDE" from debugging guidance and adding a dedicated "Debugging Guide" entry provides clearer navigation and aligns with the PR objective to adjust click-through paths. The new structure allows readers to find debugging resources without traversing PyCharm setup.

15-19: Clarify USDBook resource retention.

The PR objectives mention updating and removing deprecated resources. USDBook by Remedy Entertainment (line 19) is currently included, but its retention status is unclear. Confirm whether this resource should remain or be removed.

8-13: Strong onboarding improvements with SDK reference and video embed.

The rewritten Getting Started section effectively introduces the Omniverse Kit SDK foundation and adds a visual learning resource via embedded YouTube video for "Build Your First Omniverse Extension With OpenUSD." The video link is active and directly relevant to the Omniverse extension development context. This addresses the PR objective to ease onboarding for new developers.

docs_dev/DEBUGGING_GUIDE.md

nxkb

Thanks for doing this. Looks good to me, just need those 2 minor notes addressed.

docs_dev/CONTRIBUTING.md

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs_dev/DEBUGGING_GUIDE.md (1)
36-36: Minor grammatical refinement.

Line 36 uses slightly awkward phrasing: "we already have setup" should be "we have already set up" or "we've already set up" for consistency with standard English.

Apply this diff for improved grammar:
-For example for VSCode or Cursor, we already have setup `.vscode/launch.json`, otherwise you can create your own with a
+For example for VSCode or Cursor, we have already set up `.vscode/launch.json`, otherwise you can create your own with a

📜 Review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 88a9496 and 134f3cc.

📒 Files selected for processing (1)

docs_dev/DEBUGGING_GUIDE.md (1 hunks)

🔇 Additional comments (1)

docs_dev/DEBUGGING_GUIDE.md (1)

29-30: Documentation clarifies VS Code extension enablement workflow.

The updated content properly explains the new flow for enabling omni.kit.debug.vscode via lightspeed.app.trex_dev.bat. However, verify that the .vscode/launch.json file referenced on line 36 exists and contains valid configuration before merging.

MDDBULLDOGG · 2025-12-04T23:58:16Z

Requested changes should all be resolved at this point

MDDBULLDOGG · 2025-12-04T23:58:27Z

I have read the CLA Document and I hereby sign the CLA

MDDBULLDOGG added 2 commits December 3, 2025 17:28

Update Documentation

2033a67

Remove non-maintained links Add useful getting started documentation Clarify debugging guide

Formatting fixes

11e672f

coderabbitai bot reviewed Dec 3, 2025

View reviewed changes

docs_dev/DEBUGGING_GUIDE.md Outdated Show resolved Hide resolved

nxkb requested changes Dec 4, 2025

View reviewed changes

docs_dev/CONTRIBUTING.md Show resolved Hide resolved

nxkb self-assigned this Dec 4, 2025

nxkb added the documentation Improvements or additions to documentation label Dec 4, 2025

MDDBULLDOGG added 2 commits December 4, 2025 18:32

Add note about CLA to contributor documentation

88a9496

Fix backtick formatting in DEBUGGING_GUIDE.md

134f3cc

coderabbitai bot reviewed Dec 4, 2025

View reviewed changes

Replace 404'd resource with new OpenUSD resource

b8ffc0a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Contributor Documentation Updates #8

Contributor Documentation Updates #8

Uh oh!

MDDBULLDOGG commented Dec 3, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 3, 2025 •

edited

Loading

Review ran into problems

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

nxkb left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

MDDBULLDOGG commented Dec 4, 2025

Uh oh!

MDDBULLDOGG commented Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Contributor Documentation Updates #8

Are you sure you want to change the base?

Contributor Documentation Updates #8

Uh oh!

Conversation

MDDBULLDOGG commented Dec 3, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Review ran into problems

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nxkb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

MDDBULLDOGG commented Dec 4, 2025

Uh oh!

MDDBULLDOGG commented Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MDDBULLDOGG commented Dec 3, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Dec 3, 2025 •

edited

Loading

coderabbitai bot commented Dec 3, 2025 •

edited

Loading