Maintenance: build API Docs as part of main docs

[dreamorosi]

Summary

Our API Docs are built separately from our main docs, this requires two steps both on local envs during development and on CI.

While moving the API Docs away from TypeDoc is currently not an option, we should try to unify the two so that they're built together.

Why is this needed?

So that we can simplify our local and CI/CD setups.

Which area does this relate to?

Other

Solution

There's a 3rd party MKDocs plugin that runs TypeDoc and builds the API reference as part of the same build.

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.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments 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.