Skip to content

Conversation

@axion9
Copy link
Contributor

@axion9 axion9 commented Nov 5, 2025

Description

This pull request updates the RVC documentation to improve clarity and guide new contributors through camera setup and integration. Key changes include:

  • Updated instructions for creating and using a Python virtual environment for building the documentation.
  • Improved RealSense camera setup steps, including firmware update guidance.
  • Clarified references to exemplary use cases, including camera selection notes.
  • Added a new section on XACRO files and instructions for adjusting camera parameters if using a different RealSense model.
  • Fixed deprecated Sphinx arguments in conf.py to ensure successful HTML builds with Sphinx 7.2.6.

Fixes # (issue)
NA

Any Newly Introduced Dependencies

No

How Has This Been Tested?

These changes were tested locally by building the documentation from a clean environment and verifying all links, images, and Sphinx builds complete without errors.

Checklist:

  • I agree to use the APACHE-2.0 license for my code changes.
  • I have not introduced any 3rd party components incompatible with APACHE-2.0.
  • I have not included any company confidential information, trade secret, password or security token.
  • I have performed a self-review of my code.

@PremIntel
Copy link

PremIntel commented Nov 13, 2025

Hi @axion9, i have reviewed the commit changes under PR and noticed some minor grammar and clarity issues. I have fixed it and created a PR to merge these changes into your fork branch.

@jb-balaji jb-balaji force-pushed the feature/camera-setup-docs branch from d85e49e to f9192ae Compare November 13, 2025 10:25
@axion9
Copy link
Contributor Author

axion9 commented Nov 13, 2025

@PremIntel thanks for the improvements, I accepted each and merged!

Pirouf
Pirouf previously approved these changes Nov 18, 2025
Copy link

@Pirouf Pirouf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@kblaszczak-intel kblaszczak-intel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs team is currently working on improving a set of articles in the robotics area. We will do a review of these articles once they are merged, so that we do not block further changes.
We will also port them to the release branch.

@axion9
Copy link
Contributor Author

axion9 commented Nov 19, 2025

The docs team is currently working on improving a set of articles in the robotics area. We will do a review of these articles once they are merged, so that we do not block further changes. We will also port them to the release branch.

@kblaszczak-intel Quick question... I am going through the doc "line by line" and have found additional items that should be remediated. Should I submit changes for those, or wait until there is a doc overhaul? No worries either way, but I am finding additional items that could benefit from a fix. For example, the "Components of RVC / Vision" section is a bit confusing and dated. There are multiple examples within the 2.5D and Dynamic sections, but one is the "RealSense Node" depicted in the images doesn't appear to exist in the code. I believe this now maps to "rvc_vision_main", like this:

rvc_vision

Again, no worries if I should just wait for a doc overhaul, but let me know. - Thanks

@kblaszczak-intel
Copy link
Contributor

kblaszczak-intel commented Nov 21, 2025

@axion9 @Pirouf

I suggest we merge this one and then start fixing issues in another PR. This way all the goodness is published more rapidly. And we won't block Pirouf, I know he's also working on new content.

And if you see more potential improvements, that's awesome! Let's merge this one and start fixing what we can :) I will be happy to help. And once the content is more or less fine, we'll go through the language, structure, we'll redraw diagrams so that they are vector-based and easily editable, etc. Does that sound acceptable?

@axion9 axion9 dismissed stale reviews from kblaszczak-intel and Pirouf via a2acc95 November 23, 2025 00:04
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.

5 participants