Skip to content
Michael Glukhovsky edited this page Apr 8, 2015 · 1 revision

New web site notes

The monospace font looks like it's just browser default. It could probably be smaller and you could choose an explicit font--Anonymous Pro might match well with Freight Sans, but that's easy to play with.

When you use monospace fonts inside alert blocks, their grey background looks a little weird; it might be better to go with a color definition like rgba(127, 127, 127, 0.1) so it'll blend with the background color. (That particular one seems to give a close match to the #eee that it's currently defined as.)

Tables might look better with slightly smaller fonts, and possibly with cells vertically aligned to the top rather than left to default centering. (See the "Technical comparison table" page.)

The style for .documentation .docs-article ul makes the space above and below lists look pretty big with the padding; try looking at the "Limitations" page as-is and with the padding rule disabled. (Also something on that page makes the navigation accordion to the left collapse, but I know that accordion needs to be updated anyway.)

We might want to use a special table style for the SQL cheat sheet page to get more data visible to readers without scrolling. They're huge tables.

The cookbook pages currently have broken JavaScript for the Wufoo forms (they're both open when the page loads rather than hidden).

The Troubleshooting page needs a TOC block but the {% toctag %} looks awkward there; we probably need to come up with a different style, possibly closer to the straightforward one we have on the current website.

"Full-text search" in the nav accordion links to "Frameworks and libraries."

A few multi-language articles go to the section index page that lets you choose languages, rather than jumping to the last selected or default language like the old site does. Ones I've noticed:

  • Cookbook
  • RabbitMQ
  • Publish-Subscribe

Artwork to check

  • Introduction to ReQL (too small)
  • Map-reduce in RethinkDB (too big)
  • Using secondary indexes (maybe too big; also the TOC block could be raised to be to the right of the bullet list in the introduction?)
  • Dates and times in RethinkDB (too big)
  • Geospatial queries (has no art; the TOC block goes down too far, but can't be raised up a paragraph or it will collide with the document switcher)
  • Changefeeds (the art might be a little small?)

Something to watch out for

I've noticed in the past that our Markdown sometimes inadvertently relies on behavior from our previous processor that wasn't standard, like

# H1 headline #
## H2 subhead ##
Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Block elements in Markdown should always have blank lines between them. The old site would let you get away with formatting it without spaces, but it looks like Kramdown may not.