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

[Feature]: Update docs with FAQ section #334

Open
notaphplover opened this issue Jan 22, 2025 · 0 comments
Open

[Feature]: Update docs with FAQ section #334

notaphplover opened this issue Jan 22, 2025 · 0 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@notaphplover
Copy link
Member

notaphplover commented Jan 22, 2025

🚀 Feature Proposal

As user I want a FAQ docs section so I can search for them.

For starters, A subsection talking about common issues with bundlers would include a comprehensive guide to approach common issues when using inversify with vite. Refer to inversify/InversifyJS#1710 for more information.

Motivation

Users often experience the same issues over and over. Providing a FAQ question help them solve most of these common issues in an easy way without submiting issues in the inversify repositories.

TODO:

Update docs package at packages/docs/services/inversify-site docs with a new faq/bundlers.mdx file.

faq/bundlers.mdx should contain a general section describing that bundlers often have trouble transpiling decorated ts code and a subsection talking about vite describing how esbuild as a default bundler cannot transpile typescript decorators and how swc can be a nice alternative to it.

A minimum code example should be added even if this issue is not related to inversify. The description of the error should be included as well. It's not required to add this code example to the inversify-code-examples package, I can adapt it later 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant