Any documentation?
rishavs opened this issue · 4 comments
Hi
I want to use Pegmatite for a toy language that I am trying to build, but I am struggling with the lack of documentation. Reading through the specs is certainly helpful but not enough.
Adding some basic documentation on the grammar format and the overall way of using the lib will be highly appreciated.
@jemc I would like to create a small language but could use some pointers also - if you are available for a zoom session that would be awesome and in return I could contribute some documentation for this library
@kingsleyh - absolutely, I can always make time for a knowledge transfer session.
Please join me in chat at savi.zulipchat.com (you can log in with your GitHub ID) and we can coordinate a time that works for us both.
I apologize for the current lack of documentation. There's two layers of docs that could be desired:
1️⃣ Entry-level docs to explain how Parsing Expression Grammars work and how to build with them.
2️⃣ Docs about how specifically this library implements PEGs and what features are available.
For 1️⃣ I could recommend getting a foundation by reading some other articles about PEGs, like perhaps this series by Python's Guido van Rossum.
But for 2️⃣ obviously the only way forward is to add some docs here. And I welcome any help with those who have bandwidth to contribute, as I am spread rather thin already with my own language project, Savi needing a lot of attention to get it to maturity (including a lot of missing docs on that side as well).
@jemc Will api reference be possible? I see there there are lots of comments in the source already. Can they be generated into docs that we can add to the wiki?
I think that alone will be a great help for anyone looking to start with your lib.
PS. just checked out Savi. Looks pretty interesting!
Great thanks - joined the zulip chat and also taking a look at the PEG series.