RobotecAI / RobotecAI/rai

Documentation update and cleanup

Open
#203 0 comments 0 reactions 1 assignee View on GitHub

@maciejmajek is already working on this.

Since Apr 17, 2025.

documentation enhancement priority/major
Dominant language
Python
Stars
589
Forks
76
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Is your feature request related to a problem? Please describe.
Most of main documentation is now in good form. However, parts of auxilary documentation are not actionable and serve no apparent purpose. Some other parts are outdated or inaccurate. Small parts are still missing.

Describe the solution you'd like
The smaller tasks are needed to bring documentation up in quality:

  • Replace "human robot interface" with "human robot interaction" for HRI.
  • Document internal rai_interfaces for developer docs.
  • Describe state retrieval and how the default works vs what developers might want to add / change.
  • Improve Hello RAI example in the main README - currently it misses action path and is too generic (doesn't answer the "how?" question).
  • Rework docs on manipulation - they serve no clear purpose currently. There should be a chapter on how to make RAI work with moveIt2, and a link to the manipulation demo.
  • Rework or remove docs on multimodal_messages. What is actionable for users?
  • Update vendors documentation. Have clear messaging about vendor support (overall and specific features).

Additional context
The task can be broken into smaller pieces or done in bulk.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.