Documentation changes (first half): Use only a single README.md per device #1611
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
area-device-bindings
krwq
reviewed
Jul 22, 2021
src/devices/Bmxx80/README.md
Outdated
| @@ -17,6 +16,81 @@ The implementation supports the following devices: | |||
|
|
|||
| 3 examples on how to use this device binding are available in the [samples](samples) folder. | |||
There was a problem hiding this comment.
moved it after the basic usage
krwq
reviewed
Jul 22, 2021
src/devices/BrickPi3/README.md
Outdated
| @@ -311,3 +311,47 @@ The only supported sensors in the GrovePi port present on BrickPi3 are I2C senso | |||
|
|
|||
| A series of hardware tests for motors and sensors are available in [BrickPi3.samples](./samples). Those hardware tests offers a variety of low level access to the Brick class as well as high level thru the Motor and Sensor classes. | |||
|
|
|||
| ## Example | |||
|
|
|||
| Refer to the [sample code](./samples) to understand on which port you'll need to plug motors and sensors. The available tests are the following: | |||
There was a problem hiding this comment.
Suggesting to remove links to samples - this will not look good if we port these docs to the official documentation - most likely the link will be broken
There was a problem hiding this comment.
That's a good catch. We may then want to replace by an absolute link on the repo?
krwq
reviewed
Jul 22, 2021
src/devices/CharacterLcd/README.md
Outdated
| ## References | ||
| ## Character LCD display Samples | ||
|
|
||
| [Different samples](./samples) are provided. The main method will use the Board's Gpio pins to drive the LCD display. The second example will instead use an MCP Gpio extender backpack to drive the LCD display. Also the second example can use Grove RGB LCD Backlight via i2c bus. This second example has been tested on a CrowPi device and Grove LCD RGB Backlight device. |
krwq
reviewed
Jul 22, 2021
src/devices/Dhtxx/README.md
Outdated
|
|
||
| #### I2C Protocol | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
krwq
reviewed
Jul 22, 2021
src/devices/Dhtxx/README.md
Outdated
|
|
||
| This sample application allows you to select either a DHT10 through I2C either any other supported DHT through GPIO: | ||
|
|
||
| ```texy |
krwq
reviewed
Jul 22, 2021
src/devices/Display/README.md
Outdated
| @@ -38,7 +35,7 @@ Thread.Sleep(5000); | |||
| // Turn on buffering | |||
| display.BufferingEnabled = true; | |||
|
|
|||
| // Write -42�C to display using "decimal point" between 3rd and 4th digit as the � character | |||
| // Write -42�C to display using "decimal point" between 3rd and 4th digit as the � character | |||
There was a problem hiding this comment.
Suggested change
| // Write -42�C to display using "decimal point" between 3rd and 4th digit as the � character | |
| // Write -42°C to display using "decimal point" between 3rd and 4th digit as the ° character |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The idea is that samples/README.md should not exist and only one README.md file per device should be used.
This will make it easier to make READMEs visible in the documentation.
See #1610 for the second part
Microsoft Reviewers: Open in CodeFlow