search

rethinkdb / docs

RethinkDB documentation
http://rethinkdb.com/docs
Apache License 2.0
117 stars 167 forks source link

Referencing known bugs in documentation #1187

Open analytik opened 7 years ago

analytik commented 7 years ago

I feel like there are some issues in RethinkDB - whether by design or otherwise - and at least from an outsider's perspective these might be surprising and unpleasant. Right now, a lot of these are probably performance issues, e.g. don't use filter when you want to use getAll, etc.

I was wondering if we could start using a new subheading Known issues when documenting individual commands, and list the most relevant, verified issues from the rethinkdb/rethinkdb project.

For example, I would reference https://github.com/rethinkdb/rethinkdb/issues/6012 in api/skip page.

I feel with RethinkDB becoming an open project, the development velocity will go down at first - likely we won't get 4 major releases per year like in 2015 - which means bugs will survive longer than before, thus documenting them won't be as temporary as before.

AtnNn commented 7 years ago

That seems like a good idea to me. Could you open this issue in https://github.com/rethinkdb/docs? A PR might be welcome too.