rethinkdb / rethinkdb/docs

add a FAQ entry about why the JavaScript driver does not work in the browser

Open
#1,132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

There have been a few cases of people trying to use the JavaScript driver straight from a browser (latest: rethinkdb/rethinkdb#5802). We should probably have an entry in the FAQ that explains why this does not work, and directs them to a better explanation about what the architecture should be (along with a direct to Horizon).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing FAQ structure and the architecture explanation referenced by the issue. Explain why using the JavaScript driver directly in a browser does not work, link to the better architectural guidance, and include a direct link to Horizon; done when the FAQ entry covers all three points.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.