Documentation

[cremebrule]

Inspiration from robosuite documentation, orbit documentation, and isaac sim documentation

Sections

Introduction

Brief introduction to OG -- basically: should answer (1) Why OG? and (2) How can I get quickly started? Should link colab link here too

• [x] Overview @cremebrule
  • High-level description of OG with quick description of core features (see this one for inspiration)
• [x] Installation (we already have this section, needs updating) @wensi-ai
• [x] Quickstart (we already have this section, needs updating) @wensi-ai
• [x] Examples (we already have this section (called Building Blocks, rename + needs updating + new added examples) @hang-yin @wensi-ai

Modules

This is the heavy-lifting section: the goal is to convey critical information about OG operates and is connected internally between the different modules in an easy to understand and concise. We should be methodical and clear but avoid over verboseness -- we don't want to overwhelm our audience.

• [x] Overview @cremebrule
  • High-level description of OG infra with core flow diagram (see this one for inspiration). @cremebrule will provide the flow diagram
• [x] Prims @hang-yin
  • High-level description of OG Prim concept and how it interfaces with the rest of OG
  • Thin descriptor of the BasePrim class + API dump here
• [x] Robots @cremebrule
  • High-level description of OG Robot concept and how it interfaces with the rest of OG (see this one for inspiration)
  • Thin descriptor of the BaseRobot class + API dump here (see this one for inspiration)
• [x] Controllers @cremebrule
  • High-level description of OG Controller concept and how it interfaces with the rest of OG (see this one for inspiration)
  • Thin descriptor of the BaseController class + API dump here (see this one for inspiration)
• [x] Sensors @hang-yin
  • High-level description of OG Sensor concept and how it interfaces with the rest of OG (see this one for inspiration)
  • Thin descriptor of the BaseSensor class + API dump here
• [x] Objects @wensi-ai
  • High-level description of OG Object concept and how it interfaces with the rest of OG (see this one for inspiration)
  • Thin descriptor of the BaseObject class + API dump here
• [x] Object States @cremebrule
  • High-level description of OG Object State concept and how it interfaces with the rest of OG
  • Thin descriptor of the BaseObjectState class + API dump here
• [x] Scenes @wensi-ai
  • High-level description of OG Scene concept and how it interfaces with the rest of OG
  • Thin descriptor of the BaseScene class + API dump here
• [x] Tasks @cremebrule
  • High-level description of OG Task concept and how it interfaces with the rest of OG
  • Thin descriptor of the BaseTask class + API dump here
• [x] Environments @hang-yin
  • High-level description of OG Environment concept and how it interfaces with the rest of OG
  • Thin descriptor of the Environment class + API dump here (see this one for inspiration)
• [x] I/O Devices @wensi-ai
  • High-level description of OG IODevice concept (@wensi-ai , feel free to rename, I forgot what you named the i/o device class) and how it interfaces with the rest of OG (see this one for inspiration)
  • Thin descriptor of the IODevice class + API dump here (see this one for inspiration)

Global APIs

This includes descriptions of singletons that exist in OG, i.e.: they can be accessed as a monolithic class from anywhere

• [x] Simulator @cremebrule
  • Description + API dump
• [x] TransitionRules @ChengshuLi
  • Description + API dump
• [x] Systems @ChengshuLi
  • High-level description of OG Particle System concept and how it interfaces with the rest of OG
  • Thin descriptor of the BaseSystem class + API dump here

How to...

Basically, this section should include a bunch of (potentially niche, but highly useful / relevant) brief guides + code snippets

• [x] Import a Custom Object
  • May need @cgokmen to comment on this
• [x] Sample a custom BDDL Task
  • May need @cgokmen to comment on this
• [x] Collect demonstrations @wensi-ai
• [x] Generate a custom scene configuration
• [x] Save / restore simulation state @wensi-ai

Miscellaneous

Catch-all for any other important sections we didn't include

• [x] FAQs @wensi-ai @hang-yin @cremebrule
  • (see this one for inspiration)
• [x] Known Issues + Troubleshooting @wensi-ai @hang-yin @cremebrule
  • (see this one for inspiration)
• [x] Contribution Guidelines
  • (see this one for inspiration)
• [x] Changelog
  • (see this one for inspiration), can just be links to our release pages or C+P directly from there
• [x] Contact Us
  • link our discord + any other relevant communications channels here