Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Dec 25, 2025

@amotl amotl added reorganize Moving content around, inside and between other systems. cross linking Linking to different locations of the documentation. labels Dec 25, 2025
@coderabbitai
Copy link

coderabbitai bot commented Dec 25, 2025

Walkthrough

The PR reorganizes JavaScript/Node.js connectivity documentation by consolidating a single javascript.md file into a structured subdirectory containing an index page and separate documentation pages for node-postgres and node-crate drivers. Toctree entries in the main connect index are updated to reference the new index page.

Changes

Cohort / File(s) Summary
Documentation Index Updates
docs/connect/index.md
Updated two toctree entries from javascript to javascript/index to resolve links to the new JavaScript documentation index page.
JavaScript Documentation Restructuring
docs/connect/javascript.md
Removed the original JavaScript connectivity documentation page containing node-postgres and node-crate usage examples and cross-references.
JavaScript Documentation Index
docs/connect/javascript/index.md
Added new index page for JavaScript/TypeScript documentation with identifiers connect-javascript and connect-typescript, including description and toctree entries for node-postgres and node-crate driver pages.
Node.js Driver Documentation
docs/connect/javascript/node-postgres.md, docs/connect/javascript/node-crate.md
Added two new driver-specific documentation pages with installation instructions, code examples, and reference links for node-postgres (with pg and pg-cursor) and node-crate HTTP client connectors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • hammerhead
  • surister
  • karynzv

Poem

🐰 Hopping through docs with glee so bright,
We shuffle the JavaScript files right—
From one to a folder, neat and clean,
Each driver now shines on its own screen!
Index guides the way with a whispered song,
Organization makes docs sing strong! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: reorganizing the JavaScript documentation section by splitting it into dedicated pages for each driver.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description clearly describes the reorganization of the JavaScript section, with each client getting a dedicated page, and provides a preview link.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch javascript

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.

@amotl amotl marked this pull request as ready for review December 25, 2025 02:48
@amotl amotl merged commit 879b87e into main Dec 25, 2025
3 checks passed
@amotl amotl deleted the javascript branch December 25, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants