From ce77506da23c65b4dd2077ae891e427ae3e3b6f1 Mon Sep 17 00:00:00 2001 From: Joseph Klix Date: Fri, 4 Aug 2023 09:46:37 -0700 Subject: [PATCH 1/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e884cb87..e82fb13c 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ cross-platform, high-performance, secure, and reliable. The libraries are bound to Python by the `awscrt` package ([PyPI](https://pypi.org/project/awscrt/)) ([Github](https://github.com/awslabs/aws-crt-python)). *__Jump To:__* -* [Installation](#Installation) +* [Installation](#installation) * [Samples](samples) -* [Getting Help](#Getting-Help) +* [Getting Help](#getting-help) * [FAQ](./documents/FAQ.md) -* [Giving Feedback and Contributions](#Giving-Feedback-and-Contributions) +* [Giving Feedback and Contributions](#giving-feedback-and-contributions) * [MQTT5 User Guide](./documents/MQTT5_Userguide.md) From 75a0d1bebe1fb4ea1ac0eb119117caf6a445aeb0 Mon Sep 17 00:00:00 2001 From: Joseph Klix Date: Fri, 4 Aug 2023 09:48:16 -0700 Subject: [PATCH 2/3] Update FAQ.md --- documents/FAQ.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/documents/FAQ.md b/documents/FAQ.md index 94c53c48..0df512d9 100644 --- a/documents/FAQ.md +++ b/documents/FAQ.md @@ -1,5 +1,15 @@ # Frequently Asked Questions +*__Jump To:__* +* [Where should I start](#where-should-i-start) +* [How do I enable logging](#how-do-i-enable-logging) +* [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup) +* [I am experiencing deadlocks](#i-am-experiencing-deadlocks) +* [Mac-Only TLS Behavior](#mac-only-tls-behavior) +* [How do debug in VSCode?](#how-do-debug-in-vscode) +* [What certificates do I need?](#what-certificates-do-i-need) +* [I still have more questions about this sdk?](#i-still-have-more-questions-about-this-sdk) + ### Where should I start? If you are just getting started make sure you [install this sdk](https://github.com/aws/aws-iot-device-sdk-python-v2#installation) and then build and run the [basic PubSub](https://github.com/aws/aws-iot-device-sdk-python-v2/tree/main/samples#pubsub) From b768e20e572a95756120e66c458dfadc6a05611e Mon Sep 17 00:00:00 2001 From: Joseph Klix Date: Fri, 4 Aug 2023 09:48:42 -0700 Subject: [PATCH 3/3] Update FAQ.md --- documents/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/FAQ.md b/documents/FAQ.md index 0df512d9..1737e8a3 100644 --- a/documents/FAQ.md +++ b/documents/FAQ.md @@ -96,7 +96,7 @@ Here is an example launch.json file to run the pubsub sample * You should have generated/downloaded private and public keys that will be used to verify that communications are coming from you * When using samples you only need the private key and it will look like this: `--key abcde12345-private.pem.key` -### I still have more questions about the this sdk? +### I still have more questions about this sdk? * [Here](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) are the AWS IoT Core docs for more details about IoT Core * [Here](https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html) are the AWS IoT Greengrass v2 docs for more details about greengrass