Skip to content

RAI 2.0 Documentation update #461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
maciejmajek opened this issue Mar 18, 2025 · 8 comments · May be fixed by #554
Open

RAI 2.0 Documentation update #461

maciejmajek opened this issue Mar 18, 2025 · 8 comments · May be fixed by #554
Assignees
@boczekbartek @maciejmajek @rachwalk
Labels
priority/major Important work that comes next after all critical and blocking tasks are completed.

Comments

@maciejmajek
Copy link
Member

maciejmajek commented Mar 18, 2025 •
edited
Loading

This issue is created for tracking documentation updates

Important

If any references or information are missing due to the absence of other files, add the following to the Markdown file:

TODO(docs): ... description...
@maciejmajek
Copy link
Member Author

maciejmajek commented Mar 18, 2025 •
edited by rachwalk
Loading

BaseAgent documentation

@maciejmajek
Copy link
Member Author

maciejmajek commented Mar 18, 2025 •
edited
Loading

BaseConnector documentation

  • BaseConnector
  • HRIConnector
  • ROS2HRIConnector
  • ROS2Connector

@maciejmajek
Copy link
Member Author

maciejmajek commented Mar 18, 2025 •
edited
Loading

Current structure

  • docs/
    • create_robots_whoami.md
    • debugging_assistant.md
    • demos/
      • agriculture.md # migrate to 2.0
      • manipulation.md # migrate to 2.0
      • rosbot_xl.md # migrate to 2.0
      • taxi.md # remove
      • turtlebot.md # migrate to 2.0
    • developer_guide.md # migrate to 2.0, expand, new file regarding creating new tools
    • human_robot_interface/
      • text_interface.md # migrate to 2.0
      • voice_interface.md
    • human_robot_interface.md # remove
    • multimodal_messages.md # move from docs/ catalog
    • ros_packages.md # move from docs/ catalog
    • setup_docker.md # move from docs/ catalog
    • tracing.md # move from docs/ catalog
    • vendors.md # move from docs/ catalog
    • vendors_overview.md # move from docs/ catalog

@maciejmajek
Copy link
Member Author

maciejmajek commented Mar 18, 2025 •
edited
Loading

Additional, requested docs

  • Tooling documentation, how to build, how to use
    5d7212c
  • ...

@maciejmajek
Copy link
Member Author

Readme

  • README.md # migrate to 2.0, simplify, move roadmap to other files

@maciejmajek
Copy link
Member Author

maciejmajek commented Mar 18, 2025 •
edited
Loading

RAI_SIM

  • README.md
  • Integrations
  • O3DE document

@maciejmajek
Copy link
Member Author

RAI_BENCH

  • README.md
  • Benchmarks

@rachwalk rachwalk mentioned this issue Mar 24, 2025
Merged
@maciejmajek maciejmajek added the priority/major Important work that comes next after all critical and blocking tasks are completed. label Apr 17, 2025
@maciejmajek
Copy link
Member Author

maciejmajek commented Apr 29, 2025 •
edited
Loading

RAI_WHOAMI

@maciejmajek maciejmajek linked a pull request May 3, 2025 that will close this issue
docs: rai 2.0 update #554
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@boczekbartek boczekbartek

@maciejmajek maciejmajek

@rachwalk rachwalk

Labels
priority/major Important work that comes next after all critical and blocking tasks are completed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: rai 2.0 update RobotecAI/rai
3 participants
@boczekbartek @maciejmajek @rachwalk