Better documentation

[Arwalk]

The current documentation is on the "quick and dirty" side. Enough to start using the library in a few minutes, but could have better explanations.

Also documenting the internals would probably be beneficial for contributors, though the code size is short enough for peope to get into fast.

[inge4pres]

@Arwalk were you thinking of expanding the README or having a full-blown doc website, e.g. with GitHub pages?
I'd love to add an "examples" folder, maybe re-using the existing protos in the tests folder, on how to used the generated code but also including build.zig files to achieve various config types.

[Arwalk]

I'm not sure we need an entire Github-pages-based website, as the library is fairly easy to use (IMO, but maybe i'm biased?). That said, having a few examples in a more structured manner would be better.

I'm open to ideas, i'd prefer that we establish what is needed and useful before starting.

On the top of my head, having examples of library use for all PB types would be nice (string, byte, submessage, ints...), one example / type to make things clear. Adding all the details for ManagedString usages would be nice.

I'll do a review of issues and subjects this week end i think, i should have a bit of time for that.

Thanks a lot for your interest.

[inge4pres]

I'm open to ideas, i'd prefer that we establish what is needed and useful before starting.

On the top of my head, having examples of library use for all PB types would be nice (string, byte, submessage, ints...), one example / type to make things clear. Adding all the details for ManagedString usages would be nice.

+1, esepcially on the ManagedString 😄
happy to come up with some examples and more changes to the README and propose a PR once we laid out what should be spelled out first.