RAI 2.0 Documentation update

[maciejmajek]

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]

BaseAgent documentation

• [x] BaseAgent
• [x] ASRAgent - https://github.com/RobotecAI/rai/pull/469
• [x] TTSAgent - https://github.com/RobotecAI/rai/pull/469
• [ ] ReActAgent
• [ ] SpatioTemporalAgent

[maciejmajek]

BaseConnector documentation

• [x] BaseConnector
• [x] HRIConnector
• [x] ROS2HRIConnector
• [x] ROS2Connector

[maciejmajek]

Current structure

• [ ] docs/
  • [x] create_robots_whoami.md
  • [x] debugging_assistant.md
  • [x] 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
  • [x] developer_guide.md # migrate to 2.0, expand, new file regarding creating new tools
    • [ ] New Agent
    • [ ] New Connector
    • [x] Tools #508
    • [ ] Best practices
  • [ ] human_robot_interface/
    • [ ] text_interface.md # migrate to 2.0
    • [x] voice_interface.md
  • [ ] human_robot_interface.md # remove
  • [x] multimodal_messages.md # move from docs/ catalog
  • [ ] ros_packages.md # move from docs/ catalog
  • [ ] setup_docker.md # move from docs/ catalog
  • [x] tracing.md # move from docs/ catalog
  • [x] vendors.md # move from docs/ catalog
  • [x] vendors_overview.md # move from docs/ catalog

[maciejmajek]

Additional, requested docs

• [x] Tooling documentation, how to build, how to use 5d7212c
• [ ] ...

[maciejmajek]

Readme

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

[maciejmajek]

RAI_SIM

• [x] README.md
• [x] Integrations
• [x] O3DE document

[maciejmajek]

RAI_BENCH

• [x] README.md
• [x] Benchmarks

[maciejmajek]

RAI_WHOAMI

• [x] README.md #540

[maciejmajek]

Main documentation issues

I need to merge #554, moving all the open question and issues here: https://github.com/RobotecAI/rai/pull/554#discussion_r2077612820 https://github.com/RobotecAI/rai/pull/554#discussion_r2077580631 https://github.com/RobotecAI/rai/pull/554#discussion_r2077482758

• potential merge of what is rai and rai intro

Errors https://github.com/RobotecAI/rai/pull/554#discussion_r2075318588

[jmatejcz]

RAI_BENCH

* [x]  README.md[x]  Benchmarks

i will update rai_bench and rai_sim if needed in next PR

[maciejmajek]

Done