Skip to content

Commit ea41efd

Browse files
authored
FAQ updates (#498)
* Update README.md * Update FAQ.md * Update FAQ.md
1 parent c0e4aad commit ea41efd

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ cross-platform, high-performance, secure, and reliable. The libraries are bound
2121
to Python by the `awscrt` package ([PyPI](https://pypi.org/project/awscrt/)) ([Github](https://github.com/awslabs/aws-crt-python)).
2222

2323
*__Jump To:__*
24-
* [Installation](#Installation)
24+
* [Installation](#installation)
2525
* [Samples](samples)
26-
* [Getting Help](#Getting-Help)
26+
* [Getting Help](#getting-help)
2727
* [FAQ](./documents/FAQ.md)
28-
* [Giving Feedback and Contributions](#Giving-Feedback-and-Contributions)
28+
* [Giving Feedback and Contributions](#giving-feedback-and-contributions)
2929
* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
3030

3131

documents/FAQ.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Frequently Asked Questions
22

3+
*__Jump To:__*
4+
* [Where should I start](#where-should-i-start)
5+
* [How do I enable logging](#how-do-i-enable-logging)
6+
* [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup)
7+
* [I am experiencing deadlocks](#i-am-experiencing-deadlocks)
8+
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
9+
* [How do debug in VSCode?](#how-do-debug-in-vscode)
10+
* [What certificates do I need?](#what-certificates-do-i-need)
11+
* [I still have more questions about this sdk?](#i-still-have-more-questions-about-this-sdk)
12+
313
### Where should I start?
414

515
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)
@@ -86,7 +96,7 @@ Here is an example launch.json file to run the pubsub sample
8696
* You should have generated/downloaded private and public keys that will be used to verify that communications are coming from you
8797
* When using samples you only need the private key and it will look like this: `--key abcde12345-private.pem.key`
8898

89-
### I still have more questions about the this sdk?
99+
### I still have more questions about this sdk?
90100

91101
* [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
92102
* [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

0 commit comments

Comments
 (0)