Create documentation site

[vigoo]

No description provided.

[aaditmshah]

Why is there no comprehensive documentation for this library? The ZIO parser home page, https://zio.dev/zio-parser/, just links to a YouTube video, https://www.youtube.com/watch?v=DEPpL9LBiyA, but video tutorials are not substitutes for proper documentation. I shouldn't have to sit through an hour long video just to understand the API of a library. It's been over a year since this issue was created but the needle hasn't moved at all.

[afsalthaj]

@aaditmshah

I think while documentation site is being created, you could try some examples which can help you use this library. Here are some of the ways that I use.

https://github.com/zio/zio-config/blob/fix_typesafe/typesafe/shared/src/main/scala/zio/config/typesafe/HoconParser.scala

or

https://github.com/zio/zio-config/blob/series/4.x/xml/shared/src/main/scala/zio/config/xml/experimental/XmlParser.scala

One is an XML parser, and the other is sort-of-a-json parser, and they are concise enough to act as a quick start.

PS: If you are already know something called Syntax in this library, then note that the above examples don't use it yet. However, it is still useful in my opinion.

Also, zio-parser, at its core present to the user, something called parser combinators. If you are comfortable with parser combinator in general (so many examples in the wild), you should be comfortable implementing anything using zio-parser.