Docs: create API docs

[dreamorosi]

Description of the improvement

Summary of the proposal
As a part of our documentation we have a section that focuses on the APIs available. The new utility should feature docstrings that will then populate the corresponding pages of this documentation.

How, where did you look for information
This unit of work tracks the activities related to having the API docs for the new utility. On an high level, these are:

• Create docstrings for each class / method / function
• Review content accuracy & wording
• Review visually the docs locally

Missing or unclear documentation
https://awslabs.github.io/aws-lambda-powertools-typescript/latest/api/modules/_aws_lambda_powertools_parameters.html

Improvement
N/A

Related existing documentation

[N/A](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/api/

Related issues, RFCs

#846

[dreamorosi]

I'm having issues with generating the API docs for all the providers given that they are not all exported at the main package index.

Opened an issue on the TypeStrong repo:
TypeStrong/typedoc#2138

[dreamorosi]

It seems that it's not possible to have multiple entry points and so, in order to have the documentation, we'll have to export all providers from the main src/index.ts.

I did some tests both with esbuild and tsc and as long as using scoped imports like (note ending):

import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';

It seems to work without throwing missing dependency errors for the other providers.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.