[docs] Add link to package overview at the top of each Python class documentation

[alexpulver]

Add link to Package Overview page in each Python class documentation. Mention that it contains examples.

Most of the usage examples are captured in package overview. On the other hand, when customers are searching for usage examples, they navigate straight to the relevant class, don't find the examples there, and give up (don't think to look in package overview). Adding a link to package overview at the top of each class page, mentioning that it contains examples, might shorten the implementation time for customers.

---

This is a 📕 documentation issue

[github-actions[bot]]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[alexpulver]

Commenting to avoid auto-close

[tim-finnigan]

Hi @alexpulver — which classes don't contain the Package Overview link? And what wording were you thinking as far as mentioning examples?

[alexpulver]

Hi @tim-finnigan! For example, all classes in https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_appsync.html do not mention package overview. When customers (myself included) search for a certain functionality, they land right in the documentation for these classes. Specific example might be https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_appsync/GraphqlApi.html.

As for wording, perhaps it worths adding something like "See package overview for more examples: https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_appsync/README.html" as the last line in the auto-generated example of each specific class in all CDK Construct Library modules. Hope that makes sense.