Skip to content

docs: comprehensive documentation accuracy and onboarding improvements#19

Open
doctor wants to merge 3 commits into
quantbagel:mainfrom
doctor:feat/docs-technical
Open

docs: comprehensive documentation accuracy and onboarding improvements#19
doctor wants to merge 3 commits into
quantbagel:mainfrom
doctor:feat/docs-technical

Conversation

@doctor
Copy link
Copy Markdown
Contributor

@doctor doctor commented Mar 31, 2026

Summary

  • New guides: Go2 quickstart, Innate bot, and Teleoperation docs
  • Accuracy fixes: Line-by-line audit of all docs against code — fixed broken paths, incorrect CLI flags, wrong state dimensions, incomplete API signatures, stale READMEs, and misleading descriptions
  • Onboarding improvements: Added Contributing section to README, start-here guidance in docs index, clarified examples directory split, rewrote cli/README.md to match actual commands
  • API fix: Re-exported SO101_CONFIG, GO2_CONFIG, G1_CONFIG, INNATE_CONFIG from rfx package root so rfx.SO101_CONFIG works as documented
  • Formatting: Applied ruff format to collection and runtime CLI modules

Details

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)
  • Updated docs/README.md, docs/python-sdk.md, docs/sim.md, docs/operator-checklist.md, docs/structure.md, docs/workflow-cli.md with Innate references and streamlined content

Accuracy and onboarding fixes (commit 2)

  • docs/so101.md: Fixed rfx collectrfx record, corrected script path
  • cli/rfx.sh: Fixed so101-bimanual paths to rfx/examples/ and rfx/configs/
  • docs/go2.md: Reverted state_dim to 34 (matches YAML + observe code), added urdf_path, fixed doctor description
  • cli/README.md: Complete rewrite to document all actual commands
  • rfx/examples/README.md: Fixed so101_quickstart path, added g1_teleop.py
  • AGENTS.md: Noted hooks are auto-installed by setup script
  • rfx/__init__.py: Added robot config re-exports
  • README.md: Added Contributing section with prerequisites
  • docs/workflow-cli.md: Removed phantom --device CLI flag, removed innate from rfx record, added missing --output and --task flags
  • docs/python-sdk.md: Completed deploy() signature, added workflow/utils/nn.py to layout, clarified MockRobot deps
  • docs/teleop.md: Completed run() reference with otel params
  • docs/innate.md: Fixed CDR header terminology
  • docs/sim.md: Fixed Genesis Python version (<=3.13)

Formatting fix (commit 3)

  • Applied ruff format to rfx/python/rfx/collection/__init__.py and rfx/python/rfx/runtime/cli.py

Test plan

  • All 683 Python tests pass
  • All 144 Rust tests pass
  • Ruff format: 100 files clean
  • Mypy: no issues
  • rfx.SO101_CONFIG, rfx.GO2_CONFIG, rfx.G1_CONFIG, rfx.INNATE_CONFIG verified importable
  • rfx doctor runs successfully
  • Pre-commit hooks pass

doctor added 3 commits March 31, 2026 10:53
- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant