Agent-friendly conventions for openusd-cheatsheet.md - #72
Merged
Conversation
…gents The cheatsheet is consumed by agents (LLMs, MCP servers, RAG pipelines) as well as humans. Agents need signals humans infer from context: vendor scope, renderer scope, freshness, and validation-layer disambiguation. This commit adds those signals without bloating the page for humans. Changes: * Add agent-readable metadata block (HTML comment with last_verified, openusd_version_target, audience, tag vocabulary). Invisible in rendered view; parseable by anything reading the markdown source. * Note the tag convention briefly in the intro paragraph. * Append source/scope tags to every link: [OpenUSD], [NVIDIA], [Kit], [OVRTX], [Isaac]. Multiple tags allowed (e.g. [NVIDIA, Kit]). * Recast `## Agents` from "instructions about agents" to "For Agents Consuming This Page" — orient the agent toward primary sources, layer disambiguation, and freshness verification. Drops the volatile "Current models (GPT 5, Opus 4)" snapshot. * List NVIDIA OpenUSD-related MCP servers (kit-dev, usd-code, isaac-sim, omni-ui) alongside Kit USD Agents. URLs pending — listed by name. * Soften SimReady framing from "a standard and ecosystem" to "NVIDIA's specification and ecosystem" — accurate to current status. * Update glossary link from /22.08/ (outdated) to /release/ (always-latest). * Tag bullets in Kit Runtime Performance per scope ([NVIDIA, Kit] vs [NVIDIA, OVRTX] for renderer-specific items like Geometry Streaming). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
USDA is text-based USD intended for humans to read and edit. "Human- readable" captures that intent more directly than "ASCII-formatted" (USDA also accepts UTF-8, so ASCII understates the format). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…irection
Earlier framing ("a standard and ecosystem") overstated current status.
Subsequent framing ("NVIDIA's specification and ecosystem") understated
the multi-vendor intent — SimReady is currently NVIDIA-led but explicitly
designed to evolve toward shared industry standards rather than stay
vendor-private. This rewrites the intro to be honest about today and
clear about where it's going.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
asluk
marked this pull request as ready for review
April 29, 2026 21:14
jshrake-nvidia
approved these changes
Apr 29, 2026
jshrake-nvidia
left a comment
Contributor
There was a problem hiding this comment.
This looks good to me. I audited all the tags against the links and everything makes sense.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
#71 added
docs/openusd-cheatsheet.mdas a human-readable single-page entrypoint. Real-world consumption is mixed — humans skim it, agents (LLMs, MCP servers, RAG pipelines) ingest it. Agents need signals humans infer from context: vendor scope (OpenUSD vs NVIDIA), renderer scope (Kit vs OVRTX), freshness, validation-layer disambiguation, decision rubrics over flat lists.This PR makes those signals explicit and machine-readable without bloating the page for humans.
What's in this PR
Front-matter metadata (HTML comment)
Invisible in rendered view; parseable by anything reading the markdown source.
Source/scope tags on every link
Tag vocabulary:
[OpenUSD],[NVIDIA],[Kit],[OVRTX],[Isaac],[Community]. Multiple tags allowed.Example:
Quick visual scan for humans; structural metadata for agents; vendor-neutrality becomes grep-able.
Recast
## Agentssection — instructions for agents, not about themDrops the "Current models (GPT 5, Opus 4)" snapshot (which dates fast). Replaces with:
[OpenUSD]first, then[NVIDIA])[OVRTX]from[Kit])last_verifiedin metadata)Folded-in framing / factual fixes
/22.08/→/release/(always-latest)Out of scope (next iteration)
Saved for follow-up PRs to keep this one focused:
## How Do I Optimize?and## Best Practicesinto decision rubrics (file-format / composition / runtime / asset-structure layers)DON'T → DO → becausetriplesdocs/openusd-cheatsheet.json— same content as structured data, ingestible by MCP servers / RAG pipelines without parsing markdownImplementation notes