adonisjs / v6-docs

Documentation website for AdonisJS v6
42 stars 69 forks source link

Full file examples #42

Closed fpolli closed 6 months ago

fpolli commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

Yes, that would be a great addition. Thank you!On Feb 20, 2024, at 11:40 PM, Romain Lanz @.***> wrote: 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 add 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

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

fpolli commented 7 months ago

@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