DOCS-2957: Change docs for Modularize Components epic #3668
Conversation
viambot
added
the
safe to build
| @@ -95,7 +95,7 @@ For more information, see [Camera Component](/components/camera/). | |||
|
|
|||
| {{<imgproc src="appendix/try-viam/rover-resources/viam-rover/accelerometer.jpg" resize="400x" declaredimensions=true alt="A ADXL345 accelerometer" >}} | |||
|
|
|||
| The [ADXL345](/components/movement-sensor/adxl345/) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements. | |||
| The [ADXL345](https://github.com/viam-modules/analog-devices/tree/main/adxl345) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements. | |||
There was a problem hiding this comment.
here, and pretty much everywhere else I replaced links, I linked to the specific folder of the model in question. would you prefer I instead link to either the repo at the top level which could contain multiple models, to the readme itself, or to the section in the readme about configuring the model in questions?
There was a problem hiding this comment.
I'd prefer we link to the repo at the top level so people can see the configuring info, exactly. I can change that
There was a problem hiding this comment.
that also future proofs it if model names change etc
|
for the failing lint issues, it's because the links in the changelog don't exist anymore. I assumed I should not touch the changelog, but should I fix those links? |
|
Thank you @martha-johnston for your work on this, I can fix up the links and will do a quick review of the readmes too |
docs/appendix/try-viam/rover-resources/rover-tutorial-fragments.md
Outdated
Show resolved
Hide resolved
docs/appendix/changelog.md
Outdated
| | gripper | [`softrobotics`]() | | ||
| | motor | [`encoded-motor`]() | | ||
| | motor | [`gpiostepper`]() | | ||
| | motor | [`roboclaw`]() | |
There was a problem hiding this comment.
@martha-johnston what happened with these? Have they just been removed?
There was a problem hiding this comment.
softrobotmics is removed, encoded-motor and gpiostepper have no changes, and roboclaw was modularized but it's in my namespace instead of the viam namespace
docs/appendix/changelog.md
Outdated
| | power sensor | [`ina219`](https://github.com/viam-modules/texas-instruments) | | ||
| | power sensor | [`ina226`](https://github.com/viam-modules/texas-instruments) | | ||
| | sensor | [`bme280`](https://github.com/viam-modules/bosch) | | ||
| | sensor | [`ds18b20`]() | |
There was a problem hiding this comment.
also in my namespace instead of the viam namespace
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3668 |
npentrel
changed the title
It's up to you, technically these components still exist in rdk, they won't be removed until next week and maybe some the week after. but the modules already exist and are usable. basically there's two versions of all these components right now. we can either keep using the existing docs until those components are deleted from rdk, or start pointing to the module documentation now. I have no opinion on this |
|
I think might as well merge now |
|
cool thanks @npentrel !! |
This PR removes the documentation from Viam docs for all modularized components. Scope on modularizing components can be found here. The information from all the deleted files has been moved to the individual READMEs of the modules on GitHub, which are all linked below. I will also go through the docs repo and switch any links to deleted files to the relevant module itself.
viam:sensirion:shtx3d
viam:beagleboard:beaglebone
viam:numato-lab:usb-gpio
viam:robotiq:2f-grippers
viam:up:upboard
viam:bosch:bme280
viam:customlinux:customlinux
viam:ams:as5048
viam:pca:pca9685
viam:hardkernel:odroid
viam:orange-pi:orangepi
viam:nvidia:jetson
viam:dimensionengineering:sabertooth
viam:uln2003:28byj-48
viam:tdk-invensense:mpu6050
viam:wit-motion:imu-wit & viam:wit-motion:imu-wit-hwt905
viam:analog-devices:tmc5072 & viam:analog-devices:adxl345
viam:texas-instruments:ti & viam:texas-instruments:ina219 & viam:texas-instruments:ina226
viam:gps:rtk-serial & viam:gps:rtk-pmtk & viam:gps:nmea & viam:gps:rtk-dual-gps