Improving API Documentation Ergonomics

[lancecarlson]

I'm been going through various searches of the docs and observing what pages appear first in the list based on things I searched for in the past when I ran into issues. I think pages that appear first in the results should link to other pages with examples, or should somehow be moved in the order they appear in search (no idea if this is possible). One example of this is nullable. If you do a search for nullable, Nullable appears before nullable. To me, the nullable page is much more useful because it includes an example. Should the Nullable page ALSO include an example, or should it just link to the nullable page OR is there a way to hijack the search ranking?

Anyway, I wanted to reserve this ticket for areas where I see more of these things crop up and general questions I know I will be having as I move forward with trying to improve the docs in general.

[lancecarlson]

Another suggestion I was thinking about was to have a table for each database that shows a list of the rust types that correspond with the schema types and the exact database type. Currently it is a bit cumbersome to have to click on each type to look these up. I'm sure it will also reduce the amount of questions that come through gitter about what types need to be used.