Add descriptions in SDK docs

[jkodroff]

Hello!

• Vote on this issue by adding a 👍 reaction
• If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

It would be helpful to add descriptions to the packages, interfaces, and classes.

Packages are particularly bare, so a sentence on what the package is about would be helpful for navigating the docs. It would also be helpful to note when a package is not really meant for external consumption in Pulumi programs (.internal implies this, but codegen is also probably not for use by end users either):

Coverage in classes is better, but still not complete:

Adding linting would be cool if it's easy enough.

Affected area/feature

[kjswaruph]

Hello can i take up this issue?

[jkodroff]

@kjswaruph Absolutely! This would probably be a great place to use an LLM to assist.

[kjswaruph]

@jkodroff Hey i have created pr #1850 for this issue please review and let me know if there are any changes needed. Thank you

[jkodroff]

@kjswaruph I'm not qualified to review, but I will be happy to follow up with the team to make sure someone looks at your PR.

Thank you so much for doing this!