The documentation sucks

[VesperQuartz]

Especially for beginners that are not used to this concept. It is supposed to start easy and also explain the why? Also, no real world usage examples where it would be useful, like things we normally do while writing JavaScript.

[khill-fbmc]

https://github.com/supermacro/neverthrow/wiki/Basic-Usage-Examples

No real world examples? Did you even open the wiki?

[codeit-ninja]

https://github.com/supermacro/neverthrow/wiki/Basic-Usage-Examples

No real world examples? Did you even open the wiki?

You basically proved his point by linking to the wiki. The problem is that the wiki is almost empty, with lots of headers, no real content, and “todo” placeholders.

For many developers, especially juniors, and honestly a lot of folks in the JavaScript world, programming paradigms just aren’t that familiar. That’s why a proper blog post that explains the idea, shows best practices, and puts it all into context would be really valuable.

Right now, the README is tough to follow. The syntax isn’t very approachable for most people, and TypeScript doesn’t exactly make it more readable with things like (U extends T, R extends Result) :)

[supermacro]

Maybe this might help: https://gdelgado.ca/type-safe-error-handling-in-typescript#title

It's been hard for me to review code contributions in recent time. But if folks want to contribute to making the docs and wiki better then I can make some time to review that.

This is open source; meaning you can make it not suck :)