The purpose of the examples folders

[HasturDev]

So I attempted to use some of the examples folders on a fresh install of linux and it seems that they don't work out of the box. I fixed one to build each file out of the box as though it was a standalone main.rs on a fresh linux system. Should I create a fork and push this or is the examples purpose supposed to be something different? https://github.com/HasturDev/pingora/tree/main/pingora-proxy/examples

[johnhurt]

I had the same question when I started working in rust. The examples folder is a cargo-specific thing. It lets the create author include runnable examples without creating multiple full-fledged cargo projects for each. The good thing about it is those projects are type checked and guaranteed to compile with the version of the crate they are with. You can run each example pretty easily with cargo run --example load_balancer for load_balancer.rs.

The bad part is you can't run those examples easily outside of the crate's context.

[HasturDev]

ah ok so it's probably a good idea of taking these examples and putting them off into a tutorial on medium or something like that rather than in the repo itself. Something that lets people learn to build each piece by itself not something that should be included with the completed whole library

[johnhurt]

Yeah, we have one walk through like that in our QuickStart guide, but more would be nice.

[HasturDev]

Alright then I'll take these, turn them into a walk through folder, pr and see what you guys think

[johnhurt]

Awesome! That would be amazing 🤩