Skip to content
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.

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

Documentation update and cleanup #203

Open
7 tasks
adamdbrw opened this issue Sep 5, 2024 · 0 comments
Open
7 tasks

Documentation update and cleanup #203

adamdbrw opened this issue Sep 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@adamdbrw
Copy link
Member

adamdbrw commented Sep 5, 2024

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.

@adamdbrw adamdbrw added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant