Documentation needs to have examples

[xenoterracide]

🐞 Bug Report

Describe the bug

It would appear that by randomly clicking types in the documentation, a great number, if not most of the types do not have examples nor do they declare their intent. Because of this I find this library to be incredibly difficult to make use of. actually I don't because I can never tell if its types can help solve my problem, or how to actually use them. It would be incredibly useful if someone(s) were to make a concerted effort to increase documentation coverage and ensure new types were covered to a higher standard.

[danawoodman]

Chiming in here with the same sentiment. A lack of examples and at least a description of what the types do makes this (probably great) library much less useful than it could be.

Here are some of the things that would help the docs site:

• Add examples and a description of why you'd want to use it for every helper
• Better search: Search seems broken, I just see Preparing search index. A cmd+k menu with quick search would be great.
• Group helpers by category Any, Boolean, Class, etc with headings that are collapsible. There is a lot of extra "noise" with the prefixes in front of every sidebar link
• Make the code samples legible, the highlighting theme is impossible to read (reported in issues a few times)
• Don't navigate to a new URL on every change as this breaks the scroll position (SPA would work)

For reference, here are just a few of the other tickets describing docs/examples related topics:

• Could we have an example of how to use O.Either? #223
• Fix isNegative examples #304
• New documentation site #112
• Export If and Improve docs #329