gcanti / io-ts

Runtime type system for IO decoding/encoding
https://gcanti.github.io/io-ts/
MIT License
6.71k stars 329 forks source link

reorder documentation to make it more beginner-friendly #687

Closed phiresky closed 1 year ago

phiresky commented 1 year ago

This adds a full (validation) example to the beginning of index.md, and moves the combinators table up a bit.

I think there's more improvements that could be done, but this is a start.

tbh I'm not sure if I modified the right file because docs/index.md also exist but I don't think is used / referenced anywhere?

Relevant issue: https://github.com/gcanti/io-ts/issues/468