docs

docs copied to clipboard

Our elections tutorial is terrible

4

The code seems at best loosely connected to its own descriptions, and the input dataset is absurdly complicated.

mlucy

We should write an example on how to catch errors and how to access the error types (in all languages) It's somehow the documentation for https://github.com/rethinkdb/rethinkdb/issues/1926

neumino

People still have a lot of good architecture questions. Here are some asked by Leif that really should be answerable by pasting a link to appropriate docs: https://groups.google.com/forum/#!topic/rethinkdb/kCozjR3b_es

coffeemug

Style - Replace row with document

2

We use the terms `row` and `document` in the docs. Let's just use `document`.

neumino

Add links to github file to all docs (not just API docs)

2

And make them pretty icons (instead of a bar like in the API docs)! Also, API docs should show links to edit doc entries that don't have their own page.

coffeemug

We should have some docs that explain how to easily migrate data from MongoDB and MySQL.

coffeemug

Convert examples to `r.http`

2

The ten minute guide includes a dataset that's relatively annoying to copy paste (it's not too big, but big enough that copy pasting is a pain). We should upload it...

coffeemug

One connection per request vs pool See https://groups.google.com/forum/?fromgroups#!topic/rethinkdb/8cS-w0IzTJU

neumino

API JS - r.connect and r.close

2

See http://pastebin.com/GGqiqbKu We should actually write a whole example on how to connect, bind listeners for errors, run a query, close the connection.

neumino

If someone does a write (like an insert), a few things can happen - They can get back an error (if a table doesn't exist for example) - They can...

neumino