powertools-lambda-typescript icon indicating copy to clipboard operation
powertools-lambda-typescript copied to clipboard

Docs: add development and bundling setup info

Open dreamorosi opened this issue 4 months ago • 1 comments

What were you searching in the docs?

Customers using Powertools require a varying number of configs & tooling in their project depending on their setup. For example: Node.js version, TypeScript version and tsconfig.json, ESM vs CJS, bundling for production, etc.

This can be confusing, especially because some of the combinations have gotchas, and it's usually one of the first things we ask when troubleshooting customer issues (example).

Is this related to an existing documentation section?

No response

How can we improve?

We should consider adding a section or page dedicated to elaborating on the required config both for development and bundling so that customers can refer to it.

Got a suggestion in mind?

No response

Acknowledgment

  • [X] I understand the final update might be different from my proposed suggestion, or refused.

dreamorosi avatar Apr 18 '24 10:04 dreamorosi