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

Full file examples #42

Closed
fpolli opened this issue Feb 20, 2024 · 3 comments
Closed

Full file examples #42

fpolli opened this issue Feb 20, 2024 · 3 comments

Comments

@fpolli
Copy link

fpolli commented Feb 20, 2024

Hi,

The problem I have with the documentation, and it is by no means unique to Adonis but rather the norm, is the lack of full file examples. Like, with service providers, there are all these snippets of doing a binding, or a register, but nothing to show us what an entire provider file looks like. A link or a screenshot at the bottom with "Tying It All Together" would be very helpful.

@RomainLanz
Copy link
Member

RomainLanz commented Feb 21, 2024

Hey @fpolli! 👋🏻

Because it all depends on what your provider is doing.
It may be only a few lines of code (like the example), or it could be a bit bigger.

Would adding links to real providers (for example, each official package) would feel to be a great addition to you?

For example, that is the mail one: https://github.com/adonisjs/mail/blob/develop/providers/mail_provider.ts

@fpolli
Copy link
Author

fpolli commented Feb 21, 2024 via email

@fpolli
Copy link
Author

fpolli commented Feb 21, 2024

@RomainLanz That link was unbelievably helpful. I learned so much by being able to see a full-featured example in action. I've tried looking up some providers but a lot of them don't do much. Seeing one that does pretty much everything helps enormously. Answered a lot of questions. Thank you

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

No branches or pull requests

3 participants