Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 17, 2025

@amotl amotl added the cross linking Linking to different locations of the documentation. label Oct 17, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 17, 2025

Walkthrough

This pull request adds Dart language support to the CrateDB documentation by introducing a new driver card in the connectivity index and creating a comprehensive documentation page with connection examples, SSL configuration details, and usage patterns.

Changes

Cohort / File(s) Summary
Dart Driver Documentation Index
docs/connect/index.md
Added Dart language grid-item-card with link and styling, plus toctree entry pointing to new dart/index documentation
Dart Driver Guide
docs/connect/dart/index.md
New documentation page covering Dart/PostgreSQL connection setup, including pubspec.yaml configuration, connection examples, SSL usage, and reference to CrateDB-specific details

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • #407: Adds Rust driver card and documentation page following the same pattern as this Dart addition
  • #405: Adds a language driver page and updates docs/connect/index.md with grid-item-card and toctree entry using identical structure
  • #408: Adds another language driver card and documentation page with the same methodology

Suggested labels

cross linking

Suggested reviewers

  • surister
  • matriv

Poem

A rabbit hops through code so bright, 🐰
Dart documentation, clean and right,
With drivers linked and examples keen,
Connections flow—a snappy scene! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Driver: Add page about Dart' clearly and concisely describes the main change: adding documentation about the Dart driver.
Description check ✅ Passed The description, while brief, is directly related to the changeset by confirming the addition of a Dart driver documentation page and providing a preview link.
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 dart

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.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added new content New content being added. and removed cross linking Linking to different locations of the documentation. labels Oct 18, 2025
@amotl amotl force-pushed the dart branch 4 times, most recently from 60bb2b7 to 71c8b74 Compare October 21, 2025 12:57
@amotl amotl requested review from kneth and surister October 21, 2025 12:57
Copy link
Member

@kneth kneth left a comment

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new content New content being added.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants