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: Warn users about export Elysia as a default #384

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

EvHaus
Copy link
Contributor

@EvHaus EvHaus commented Aug 31, 2024

I hope you'll consider making this small documentation change. It was something I ran into when first learning Elysia and ended up wasting several minutes of troubleshooting on this.

If there's a better place to put this warning, let me know.

See elysiajs/elysia#550 for context.

@bogeychan
Copy link
Collaborator

@EvHaus, thnx for reporting this finding!


@fecony, I added a troubleshooting page instead, as this information might get lost or overlooked. Can you review it? 😄

image

@bogeychan bogeychan requested a review from fecony August 31, 2024 09:22
Copy link
Collaborator

@fecony fecony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@fecony fecony requested a review from SaltyAom August 31, 2024 11:00
@EvHaus
Copy link
Contributor Author

EvHaus commented Aug 31, 2024

Thanks for the change. I like the idea of starting a Troubleshooting page. I'll probably contribute a few more things to it later.

@bogeychan bogeychan removed their assignment Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants