Maintenance: Align API reference customer names section with user guide docs

[phipag]

Summary

The customer references section in the docs is currently not aligned with the API reference counterpart: https://docs.powertools.aws.dev/lambda/typescript/latest/api/#becoming-a-reference-customer

The goal of this issue to replace the API reference with the same contents as in the user guide docs.

Why is this needed?

This is needed to comply with AWS documentation guidelines and to deliver a consistent documentation experience.

Which area does this relate to?

Governance

Solution

No response

Acknowledgment

• This request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[dreamorosi]

Thanks for opening the issue.

A note for the implementers: the readme file for each one of the API reference pages is defined in the typedoc config file in each package. Right now we're pointing to the README.md of each package as well as the main one.

If we simply remove the customer references from the README files, then we won't have any customer reference left anywhere, since that same README is sent also to npm when publishing the package.

The correct action should probably be to do something along the lines of either:

• creating a dedicated API_README.md file without customer references and use that in typedoc
• remove the cover pages from the API reference, but keep the existing README

[Zelys-DFKH]

Traced the issue. Each package README has a customer references section that shouldn't appear in the API reference. Creating dedicated API_README.md files in all 12 packages without the customer section, then updating typedoc.json to point to those instead. Happy to open a PR if that approach looks right.