search

WildernessLabs / Meadow_Issues

Public repo for bugs and issues with Meadow
15 stars 0 forks source link

Documentation issue BME688 sensor #440

Closed NevynUK closed 7 months ago

NevynUK commented 8 months ago

There are a number of missing images in the BME688 sensor driver:

https://developer.wildernesslabs.co/docs/api/Meadow.Foundation/Meadow.Foundation.Sensors.Atmospheric.Bme688.html

To wire a Bme688 to your Meadow board, connect the following:

<img src="../../API_Assets/Meadow.Foundation.Sensors.Atmospheric.Bme688/Bme688_Fritzing.png"
patridge commented 7 months ago

Here's the API docs include file and the listed missing image. https://github.com/WildernessLabs/Documentation/blame/main/docs/api/Meadow.Foundation/Meadow.Foundation.Sensors.Atmospheric.Bme688.md#L118

I don't see any other images that are missing, but there is currently an issue with this API docs page not getting the include. It's possible there were multiple broken images as a result of WildernessLabs/Documentation#504. You can still see the old version with the include in a limited form via Bing cache. So, there may only be the one image needing a fix.

As for the referenced image, I am not finding any such BME688 Fritzing diagram to use. There is only a similar one for BME680.

patridge commented 7 months ago

Looks like there is another quirk of that new Docusaurus site. The include is being included here (but not here, note the / between the class name and the namespace). https://developer.wildernesslabs.co/docs/api/Meadow.Foundation/Meadow.Foundation.Sensors.Atmospheric.Bme688/

alexischr commented 7 months ago

Just checked real quick and this is still broken

patridge commented 7 months ago

This has been addressed on the dev release of docs. https://developer.wildernesslabs.dev/docs/api/Meadow.Foundation/Meadow.Foundation.Sensors.Atmospheric.Bme688/#wiring-example We'll want to close it when those are published to prod.