DOCS-2498: Link to main component documentation on RDK docs site

components/arm/arm.go

@@ -1,6 +1,9 @@
 //go:build !no_cgo
 
 // Package arm defines the arm that a robot uses to manipulate objects.
+// For more information, see the [Arm Component].
+//
+// [Arm Component]: https://docs.viam.com/components/arm/
 package arm
 
 import (

components/base/base.go

@@ -1,4 +1,7 @@
 // Package base defines the base that a robot uses to move around.
+// For more information, see the [Base Component].
+//
+// [Base Component]: https://docs.viam.com/components/base/
 package base
 
 import (

components/board/board.go

@@ -2,6 +2,9 @@
 // such as a Raspberry Pi.
 //
 // Besides the board itself, some other interfaces it defines are analog pins and digital interrupts.
+// For more information, see the [Board Component].
+//
+// [Board Component]: https://docs.viam.com/components/board/
 package board
 
 import (

components/camera/camera.go

@@ -1,4 +1,7 @@
 // Package camera defines an image capturing device.
+// For more information, see the [Camera Component].
+//
+// [Camera Component]: https://docs.viam.com/components/camera/
 package camera
 
 import (

components/encoder/encoder.go

@@ -1,4 +1,7 @@
-// Package encoder implements the encoder component
+// Package encoder implements the encoder component.
+// For more information, see the [Encoder Component].
+//
+// [Encoder Component]: https://docs.viam.com/components/encoder/
 package encoder
 
 import (

components/gantry/gantry.go

@@ -1,3 +1,7 @@
+// Package gantry defines a robotic gantry with one or multiple axes.
+// For more information, see the [Gantry Component].
+//
+// [Gantry Component]: https://docs.viam.com/components/gantry/
 package gantry
 
 import (

components/generic/generic.go

@@ -1,4 +1,7 @@
-// Package generic defines an abstract generic device and DoCommand() method
+// Package generic defines an abstract generic device and DoCommand() method.
+// For more information, see the [Generic Component].
+//
+// [Generic Component]: https://docs.viam.com/components/generic/
 package generic
 
 import (

components/gripper/gripper.go

@@ -1,4 +1,7 @@
 // Package gripper defines a robotic gripper.
+// For more information, see the [Gripper Component].
+//
+// [Gripper Component]: https://docs.viam.com/components/gripper/
 package gripper
 
 import (