Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add development and bundling setup info #2395

Open
1 task done
dreamorosi opened this issue Apr 18, 2024 · 1 comment
Open
1 task done

Docs: add development and bundling setup info #2395

dreamorosi opened this issue Apr 18, 2024 · 1 comment
Labels
discussing The issue needs to be discussed, elaborated, or refined documentation Improvements or additions to documentation

Comments

@dreamorosi
Copy link
Contributor

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

  • I understand the final update might be different from my proposed suggestion, or refused.
@dreamorosi dreamorosi added documentation Improvements or additions to documentation discussing The issue needs to be discussed, elaborated, or refined labels Apr 18, 2024
@dreamorosi
Copy link
Contributor Author

I am not sure yet whether this should be a section in an existing page or a standalone page.

My main doubt at this stage stems from the fact that - at least in my opinion - none of the pages we have fit this topic. This is because all pages except the home are dedicated to a specific feature while this is a cross cutting topic.

Additionally, I am unsure whether we should discuss both suggested development environment to use Powertools and bundling for production, or both. At the moment we give some guidance in the contributing section, but this is targeted primarily at the dev setup to contribute to the project.

I think overall this is an important section to be added, however I'm concerned about scope creep.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussing The issue needs to be discussed, elaborated, or refined documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant