DOCS-1459: Remove i2cs and SPIs #2319
Conversation
sguequierre
commented
Dec 12, 2023
sguequierre
commented
- Remove from the configuration of all boards where they were supported as configuration attributes
viambot
added
the
safe to build
|
Overall readability score: 56.67 (🟢 +0.16)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
| @@ -6,7 +6,7 @@ type: "docs" | |||
| description: "Configure an MPU-6050 movement sensor." | |||
| images: ["/icons/components/imu.svg"] | |||
| aliases: | |||
| - /micro-rdk/movement-sensor/gyro-mpu6050/ | |||
| - "/components/movement-sensor/mpu6050/" | |||
There was a problem hiding this comment.
Naive question: I don't understand what this line means or why it changed. What's going on here?
There was a problem hiding this comment.
This alias entry simply redirects any incoming requests forhttps://docs.viam.com/build/micro-rdk/movement-sensor/gyro-mpu6050/ (currently live, will be gone after this PR) to https://docs.viam.com/build/components/movement-sensor/gyro-mpu6050/ (not yet live, will be live after this PR) instead.
There was a problem hiding this comment.
It's not obvious to me that this PR is supposed to have a change like that. Why is it in here? I thought we were removing mention of "i2cs" and "spis" config entries in the boards, not renaming the gyroscope.
but if this is just some little nit that was supposed to go in wherever's convenient, I'm fine with it going here, too. 🤷
There was a problem hiding this comment.
@sguequierre looks like you're intending to delete one of /build/micro-rdk/movement-sensor/gyro-mpu6050.md or /components/movement-sensor/imu/mpu6050.md ? Maybe I misinterpreted your intent with my comment to Alan above?
It looks like one of these two needs to be deleted. Are we moving this movement sensor out of the micro-rdk section into components like the rest?
@penguinland this front matter section does not handle anything substantive to the rendered copy (like a displayed component name), but rather metadata-type stuff like aliases, SEO metadata, preview images for social, etc. Component names aren't being changed here.
There was a problem hiding this comment.
This sensor should be in both the micro- and regular RDKs. and since the codebases are separate, it's possible they have slightly different implementations and might need slightly different docs. Is this about unifying them to a single set of docs? I don't know what's happening in micro-rdk...
There was a problem hiding this comment.
Gotcha, thanks for the clarification. I'll let Sierra chime in with her intent then. Likely my misinterpretation, then, current PR has both files retained. 👍
There was a problem hiding this comment.
The file at /components/movement-sensor/mpu6050/ still exists. If it should stay - which is what penguinland is saying, we don't that second redirect. We do need the first one you deleted/edited.
There was a problem hiding this comment.
Sorry guys, I think this was a rebase issue that slipped past me! I didn't mean to change an alias. I edited this file at all in error, reverting now...
There was a problem hiding this comment.
Thanks! Sorry for my confusion!
docs/components/motor/tmc5072.md
Outdated
| @@ -106,7 +106,7 @@ The following attributes are available for `TMC5072` motors: | |||
| <!-- prettier-ignore --> | |||
| | Name | Type | Inclusion | Description | | |||
| | ---- | ---- | --------- | ----------- | | |||
| | `spi_bus` | string | **Required** | The board [SPI bus](/components/board/#spis) over which the TMC chip communicates with the board. | | |||
| | `spi_bus` | string | **Required** | The board SPI bus over which the TMC chip communicates with the board. | | |||
There was a problem hiding this comment.
Mild preference to remove the word "board" and have this just be "The SPI bus over which..." but I don't feel strongly. We already mention the board at the end of the sentence.
| @@ -83,7 +83,7 @@ The following attributes are available for `INA219` sensors: | |||
| <!-- prettier-ignore --> | |||
| | Attribute | Type | Inclusion | Description | | |||
| | --------- | -----| --------- | ----------- | | |||
| | `i2c_bus` | integer | **Required** | The `number` of the [I<sup>2</sup>C bus](/components/board/#i2cs) that the sensor is connected to. | | |||
| | `i2c_bus` | integer | **Required** | The index of the I<sup>2</sup>C bus that the sensor is connected to. | | |||
| @@ -6,7 +6,7 @@ type: "docs" | |||
| description: "Configure an MPU-6050 movement sensor." | |||
| images: ["/icons/components/imu.svg"] | |||
| aliases: | |||
| - /micro-rdk/movement-sensor/gyro-mpu6050/ | |||
| - "/components/movement-sensor/mpu6050/" | |||
There was a problem hiding this comment.
This alias entry simply redirects any incoming requests forhttps://docs.viam.com/build/micro-rdk/movement-sensor/gyro-mpu6050/ (currently live, will be gone after this PR) to https://docs.viam.com/build/components/movement-sensor/gyro-mpu6050/ (not yet live, will be live after this PR) instead.
| @@ -6,7 +6,7 @@ type: "docs" | |||
| description: "Configure an MPU-6050 movement sensor." | |||
| images: ["/icons/components/imu.svg"] | |||
| aliases: | |||
| - /micro-rdk/movement-sensor/gyro-mpu6050/ | |||
There was a problem hiding this comment.
@andf-viam @sguequierre why are you deleting previous aliases? Unless you are readding a page under that URL, previous URLs need to stay.
| @@ -6,7 +6,7 @@ type: "docs" | |||
| description: "Configure an MPU-6050 movement sensor." | |||
| images: ["/icons/components/imu.svg"] | |||
| aliases: | |||
| - /micro-rdk/movement-sensor/gyro-mpu6050/ | |||
| - "/components/movement-sensor/mpu6050/" | |||
There was a problem hiding this comment.
The file at /components/movement-sensor/mpu6050/ still exists. If it should stay - which is what penguinland is saying, we don't that second redirect. We do need the first one you deleted/edited.
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2319 |
