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.

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

DOCS-2498: Link from RDK docs to main docs on component pages part 2 #4352

Merged
merged 2 commits into from
Sep 9, 2024
Merged

DOCS-2498: Link from RDK docs to main docs on component pages part 2 #4352

merged 2 commits into from
Sep 9, 2024

Conversation

sguequierre
Copy link
Contributor

  • Add the rest of the components
  • Add brief descriptions for some components

@viambot viambot added the safe to test This pull request is marked safe to test from a trusted zone label Sep 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!

component function
base IsMoving
board GPIOPinByName
camera Properties
encoder Properties
motor IsMoving
sensor Readings
servo Position
arm EndPosition
audio MediaProperties
gantry Lengths
gripper IsMoving
input_controller Controls
movement_sensor LinearAcceleration
power_sensor Power
pose_tracker Poses
motion GetPose
vision GetProperties

@npentrel
Copy link
Contributor

npentrel commented Sep 6, 2024

can you add them to each method description too? Like on the python docs?

JessamyT
JessamyT approved these changes Sep 6, 2024
View reviewed changes
Copy link
Contributor

@JessamyT JessamyT left a comment

Choose a reason for hiding this comment

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

LGTM from docs side

@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Sep 9, 2024
@sguequierre sguequierre merged commit 60b08d6 into main Sep 9, 2024
20 checks passed
@sguequierre sguequierre deleted the DOC-2498/link-from-rdk-main-docs-part-2 branch September 9, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JessamyT JessamyT JessamyT approved these changes

@npentrel npentrel npentrel approved these changes

Assignees
No one assigned
Labels
safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sguequierre @npentrel @JessamyT @viambot