Skip to content

Comments

Expand JavaScript/node.js driver page a bit#546

Merged
kneth merged 4 commits intomainfrom
kneth/extend-js-first-page
Feb 11, 2026
Merged

Expand JavaScript/node.js driver page a bit#546
kneth merged 4 commits intomainfrom
kneth/extend-js-first-page

Conversation

@kneth
Copy link
Member

@kneth kneth commented Feb 10, 2026

@kneth kneth requested review from amotl and bmunkholm February 10, 2026 11:40
@kneth kneth self-assigned this Feb 10, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 10, 2026

Walkthrough

Documentation guidance is added to the JavaScript connection documentation, introducing a Driver options section that recommends node-postgres for PostgreSQL-wire compatibility and node-crate for HTTP/REST features or when facing wire protocol limitations.

Changes

Cohort / File(s) Summary
Documentation - Driver Guidance
docs/connect/javascript/index.md
Added Driver options rubric block with recommendations for node-postgres and node-crate drivers, including usage guidance for different scenarios.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

guidance

Suggested reviewers

  • surister
  • amotl

Poem

🐰 A doc so fine, with drivers two,
node-postgres for the PostgreSQL crew,
node-crate when REST is the way,
Our guidance now shines in gray!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding driver options rubric to expand the JavaScript/node.js documentation page.
Description check ✅ Passed The description is related to the changeset, referencing the issue being closed and providing a preview link to the documentation changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kneth/extend-js-first-page

No actionable comments were generated in the recent review. 🎉

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/connect/javascript/_driver_options.md`:
- Around line 4-11: Reorder the driver list so `node-postgres` appears first and
`node-crate` second, and update the explanatory paragraph to prefer
`node-postgres` for PostgreSQL-wire (PG) compatibility with `node-crate` as the
HTTP/REST fallback; remove the phrase about being "actively maintained" and
instead state the protocol-based rationale (PG-wire vs HTTP/HTTPS) succinctly,
ensuring references to the driver names `node-postgres` and `node-crate` are
preserved.

Co-authored-by: Andreas Motl <andreas.motl@crate.io>
Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the point with the include file? Are we going to reuse this somewhere else as well? If not, then just move it to the index file.

@kneth kneth merged commit 3623f18 into main Feb 11, 2026
3 of 4 checks passed
@kneth kneth deleted the kneth/extend-js-first-page branch February 11, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants