docs: comprehensive documentation accuracy and onboarding improvements#19
Open
doctor wants to merge 3 commits into
Open
docs: comprehensive documentation accuracy and onboarding improvements#19doctor wants to merge 3 commits into
doctor wants to merge 3 commits into
Conversation
- Fix docs/so101.md: correct CLI command (rfx record), fix script path - Fix cli/rfx.sh: correct so101-bimanual paths - Fix docs/go2.md: revert state_dim to 34 (matches YAML and observe code), add urdf_path, fix doctor description - Rewrite cli/README.md to reflect actual cli/rfx.sh commands - Fix rfx/examples/README.md: correct so101_quickstart path, add g1_teleop - Update AGENTS.md: note hooks are auto-installed by setup script - Add SO101_CONFIG, GO2_CONFIG, G1_CONFIG, INNATE_CONFIG re-exports to rfx/__init__.py so rfx.SO101_CONFIG works as documented - Add Contributing section to root README.md - Add start-here guidance to docs/README.md - Fix docs/workflow-cli.md: remove phantom --device CLI flag, remove innate from rfx record (not supported), add missing --output and --task - Fix docs/python-sdk.md: complete deploy signature, add missing dirs to package layout, clarify MockRobot deps - Fix docs/teleop.md: complete run() reference with otel params - Fix docs/innate.md: correct CDR header terminology - Fix docs/sim.md: Genesis works on CPython <= 3.13, not only 3.13
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.
Summary
rfx.SO101_CONFIGworks as documentedDetails
New documentation (commit 1)
docs/go2.md— Go2 quadruped quickstart (connect, observe, deploy, sim)docs/innate.md— Innate Zenoh-native bot guide (JSON/CDR formats, config)docs/teleop.md— Full teleoperation guide (run API, bimanual, cameras, transport, OTEL)docs/README.md,docs/python-sdk.md,docs/sim.md,docs/operator-checklist.md,docs/structure.md,docs/workflow-cli.mdwith Innate references and streamlined contentAccuracy and onboarding fixes (commit 2)
docs/so101.md: Fixedrfx collect→rfx record, corrected script pathcli/rfx.sh: Fixed so101-bimanual paths torfx/examples/andrfx/configs/docs/go2.md: Reverted state_dim to 34 (matches YAML + observe code), added urdf_path, fixed doctor descriptioncli/README.md: Complete rewrite to document all actual commandsrfx/examples/README.md: Fixed so101_quickstart path, added g1_teleop.pyAGENTS.md: Noted hooks are auto-installed by setup scriptrfx/__init__.py: Added robot config re-exportsREADME.md: Added Contributing section with prerequisitesdocs/workflow-cli.md: Removed phantom --device CLI flag, removed innate from rfx record, added missing --output and --task flagsdocs/python-sdk.md: Completed deploy() signature, added workflow/utils/nn.py to layout, clarified MockRobot depsdocs/teleop.md: Completed run() reference with otel paramsdocs/innate.md: Fixed CDR header terminologydocs/sim.md: Fixed Genesis Python version (<=3.13)Formatting fix (commit 3)
rfx/python/rfx/collection/__init__.pyandrfx/python/rfx/runtime/cli.pyTest plan
rfx.SO101_CONFIG,rfx.GO2_CONFIG,rfx.G1_CONFIG,rfx.INNATE_CONFIGverified importablerfx doctorruns successfully