pegasus.lua documentation updates

@EvandroLG I noticed that the documentation is lacking. In the code there are many more methods etc than explained in the docs. Especially the plugins are not mentioned.

I went through quite some code to read up on the lib. And typically I write LDoc based comments to explain to myself what the code does. I could update and clean up to create actually LDoc rendered documentation. For example; https://lunarmodules.github.io/lua-lace/manual/README.md.html

Would you accept a PR if I created it?

Jan 10 '23 20:01 Tieske

ping @EvandroLG

Feb 19 '23 12:02 Tieske

Hey @Tieske Sorry for the late reply. About the documentation, are you talking about the readme or the the Pegasus.lua page (http://evandrolg.github.io/pegasus.lua/)?

Feb 19 '23 13:02 EvandroLG

both are outdated.

Feb 19 '23 19:02 Tieske

What precisely do you think we should include in the readme.md that's not present there? Anyway, I like the idea of using LDoc to generate the documentation. If you want, feel free to open a draft PR to discuss how the page should look like :)

Feb 27 '23 20:02 EvandroLG