| --- |
| license: bsd-3-clause |
| pretty_name: Isaac Lab Documentation Assets |
| tags: |
| - isaac-lab |
| - robotics |
| - documentation |
| --- |
| |
| # Isaac Lab Documentation Assets |
|
|
| Images, animations, and videos embedded in the |
| [Isaac Lab documentation](https://isaac-sim.github.io/IsaacLab/). The documentation pages |
| reference these files by URL, so they stay out of the |
| [Isaac Lab repository](https://github.com/isaac-sim/IsaacLab). |
|
|
| ## Layout |
|
|
| Folders follow the documentation topics: |
|
|
| | Folder | Content | |
| |---|---| |
| | `environments/previews/<category>/` | Task preview image (`.jpg`) and clip (`.mp4`) for the environment browser | |
| | `visualizers/` | Visualizer hero clips, showcases, live plots, and streaming demos | |
| | `renderers/` | Camera renderer comparison stills and animations | |
| | `actuators/` | Actuator parameter animations | |
| | `physics/` | MPM, deformable, and coupled-solver clips | |
| | `imitation_learning/` | Teleoperation, SkillGen, augmented imitation, and humanoid clips | |
| | `policy_deployment/` | COMPASS/NuRec, LEAPP, and sim-to-sim transfer clips | |
| | `reinforcement_learning/`, `quickstart/`, `tutorials/`, `how_to/`, `demos/` | Clips for the matching documentation pages | |
|
|
| ## Usage |
|
|
| Link a file with its `resolve` URL: |
|
|
| ``` |
| https://huggingface.co/datasets/nvidia/isaaclab-docs-assets/resolve/main/<folder>/<file> |
| ``` |
|
|
| For example, `visualizers/hero_newton_rtx.mp4`. |
|
|
| ## Contributing |
|
|
| File names are lowercase `snake_case`. Add new files under the folder that matches the |
| documentation page that uses them, and keep each file under 50 MB. |
|
|
| ## License |
|
|
| Released under the BSD-3-Clause license, the same as Isaac Lab. |
|
|
