Azure / azure-iot-explorer

Cross-platform UI for interacting with devices attached to Azure IoT Hub. This tool is meant for learning and testing, not for production environment.
MIT License
223 stars 74 forks source link

[Feature request] Extend walk-through samples for Plug and Play #441

Open jspaith opened 3 years ago

jspaith commented 3 years ago

As we're adding official PnP APIs to SDKs, this has forced a much harder look at the SDK documentation. Tagging @momuno who's been doing a lot of this review.

With the thermometer & temp controller E2E DTDLs, we want the SDK docs to help customer get as far as possible for an E2E experience. We certainly push customers to PnP in IoT Explorer, which is a great tool by the way.

I do not want to have the SDKs though documenting "Push this button in IoT explorer" and "Select this drop down." The concern is if you guys change this, the SDK content immediately becomes stale and needs updating many places.

While https://github.com/Azure/azure-iot-explorer#plug-and-play is pretty good, it flies by really fast and doesn't explicitly call out our golden example DTDL of thermostat & tempController.

Please consider either:

rido-min commented 3 years ago

Agreed, we should have a good summary in the README of this repo.

/c @dominicbetts