Build a Workflow Path#
A workflow path connects one environment to the runtime adapters, data formats, policy execution, validation, and documentation needed to reproduce an end-to-end result.
The repository does not provide a workflow path generator. Use the current Static Apple workflows as working examples and define the requirements for each stage.
Define the Workflow Components#
Add or reuse the robot-independent environment definition under
src/e2e_robot_workflows/environments/.Add the required runtime adapters: direct Isaac Lab task code belongs under
src/e2e_robot_workflows/tasks/<task>/, while Isaac Lab-Arena composition belongs undersrc/e2e_robot_workflows/arena/.Add small discovery and robot pointers under
configs/tasks/andconfigs/robots/.Add data or policy configuration under
configs/stages/and the matching package module when code is required.Add host contract tests and the smallest GPU simulation check that proves the runtime behavior.
Keep environment semantics in the shared environment definition. Runtime adapters should realize that definition instead of owning a second copy of the scene definition.
Add the User Path#
Create one workflow path overview under docs/workflows/. Link its stages in the
order that a user performs them. Keep task instructions, architectural
explanation, and exact reference data on separate pages, but make them
discoverable from the workflow path overview.
Add a card for the overview to Workflow Paths and register the overview in that page’s hidden
toctree.Register new stage pages in the overview’s hidden
toctree, in reading order. Existing shared pages already registered elsewhere need only a link.Follow the documentation style and describe only capabilities and test results supported by evidence.
Cards provide entry links; toctree entries provide sidebar and previous/next
navigation. Check both in the rendered site before submitting the change.
Validate the Contribution#
Run host validation while developing:
uv run --no-sync ./tools/validate_repository.sh host
Build and check the documentation separately:
uv run --no-sync ./tools/validate_repository.sh docs
Run the relevant simulator validation on a compatible NVIDIA GPU host. The available entry points and their scope are listed in the Developer Guide.