-
Notifications
You must be signed in to change notification settings - Fork 1
Driver: Add pages about C#, F#, Visual Basic #409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughThis PR extends the CrateDB connection documentation to support three additional .NET-based languages (C#, F#, and Visual Basic). It adds dedicated driver cards to the main drivers index grid, updates navigation structure, introduces a new links reference file, and provides language-specific documentation pages with code examples and connection guidelines. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
cd2417d to
99913d9
Compare
4df1ac3 to
bde904d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/_assets/icon/csharp-logo.svgis excluded by!**/*.svgdocs/_assets/icon/fsharp-logo.svgis excluded by!**/*.svgdocs/_assets/icon/visualbasic-logo.svgis excluded by!**/*.svg
📒 Files selected for processing (5)
docs/_include/links.mddocs/connect/csharp/index.mddocs/connect/fsharp/index.mddocs/connect/index.mddocs/connect/visualbasic/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/_include/links.md
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: amotl
Repo: crate/cratedb-guide PR: 406
File: docs/connect/go.md:110-137
Timestamp: 2025-10-20T21:49:18.785Z
Learning: In the cratedb-guide repository, documentation examples for connecting to CrateDB (e.g., Go examples in docs/connect/go.md) should be kept minimal and focused on demonstrating basic functionality, rather than including comprehensive error handling. Full examples with proper error handling are maintained separately in the cratedb-examples repository.
Learnt from: amotl
Repo: crate/cratedb-guide PR: 420
File: docs/connect/erlang.md:100-113
Timestamp: 2025-10-19T19:21:49.864Z
Learning: In the cratedb-guide repository, when documenting cloud or alternative connection methods, show only the differences from the canonical example (e.g., SSL configuration) rather than repeating the entire workflow (query execution, cleanup, etc.). This pattern is used consistently across pages to avoid repetition.
📚 Learning: 2025-10-20T21:49:18.785Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 406
File: docs/connect/go.md:110-137
Timestamp: 2025-10-20T21:49:18.785Z
Learning: In the cratedb-guide repository, documentation examples for connecting to CrateDB (e.g., Go examples in docs/connect/go.md) should be kept minimal and focused on demonstrating basic functionality, rather than including comprehensive error handling. Full examples with proper error handling are maintained separately in the cratedb-examples repository.
Applied to files:
docs/connect/csharp/index.md
📚 Learning: 2025-10-06T16:40:16.322Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 0
File: :0-0
Timestamp: 2025-10-06T16:40:16.322Z
Learning: In the crate/cratedb-guide repository, documentation is organized by content type: files in `docs/feature/`, `docs/integrate/`, and `docs/ingest/` are reference material designed for quick access, while `docs/start/` contains learning path content. Reference material sections use top-right reference layouts for efficient navigation.
Applied to files:
docs/connect/csharp/index.md
📚 Learning: 2025-10-19T19:21:49.864Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 420
File: docs/connect/erlang.md:100-113
Timestamp: 2025-10-19T19:21:49.864Z
Learning: In the cratedb-guide repository, when documenting cloud or alternative connection methods, show only the differences from the canonical example (e.g., SSL configuration) rather than repeating the entire workflow (query execution, cleanup, etc.). This pattern is used consistently across pages to avoid repetition.
Applied to files:
docs/connect/csharp/index.md
🪛 LanguageTool
docs/connect/fsharp/index.md
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...:{rubric} About ::: [Npgsql] is an open source ADO.NET Data Provider for Postgr...
(QB_NEW_EN_HYPHEN)
docs/connect/visualbasic/index.md
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...:{rubric} About ::: [Npgsql] is an open source ADO.NET Data Provider for Postgr...
(QB_NEW_EN_HYPHEN)
docs/connect/csharp/index.md
[grammar] ~21-~21: Use a hyphen to join words.
Context: ...:{rubric} About ::: [Npgsql] is an open source ADO.NET Data Provider for Postgr...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/connect/csharp/index.md
5-5: No space inside hashes on closed atx style heading
(MD020, no-missing-space-closed-atx)
83-83: Bare URL used
(MD034, no-bare-urls)
92-92: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build docs
🔇 Additional comments (5)
docs/connect/visualbasic/index.md (1)
36-69: Example structure is appropriate.The code example correctly demonstrates basic connection, query execution, and result display in Visual Basic. The explicit cleanup (lines 64–65) aligns with VB idiom and is acceptable.
docs/connect/fsharp/index.md (1)
43-76: F# example is well-structured and idiomatic.The use of Npgsql.FSharp with functional composition (pipe operators) is idiomatic F# and avoids explicit resource cleanup by leveraging the library's abstraction. The record type definition and result collection pattern are appropriate for the language.
docs/connect/csharp/index.md (2)
44-61: C# example follows minimal example guidance.The code demonstrates basic connection, query execution, and result output without explicit cleanup (no
usingstatements orDisposecalls). Per learnings from prior PRs in this repository, documentation examples should remain minimal and focused on core functionality; comprehensive error handling and cleanup belong in the cratedb-examples repository. This approach is intentional and aligns with established patterns.
7-12: CI/CD badges enhance credibility.The badges linking to active GitHub Actions workflows for Npgsql and EF Core examples add transparency and demonstrate ongoing test coverage.
docs/connect/index.md (1)
65-76: Grid cards and navigation structure are well-integrated.The three new driver cards (C#, F#, Visual Basic) are properly positioned in the grid with consistent styling (50px image heights matching other SVG logos like Scala), correct anchor references, and user-friendly
link-alttext. The toctree entries (lines 289, 292, 303) maintain alphabetical order within the drivers section. All cross-references to the new language pages are correctly established.Verify that the corresponding SVG logo assets exist:
/_assets/icon/csharp-logo.svg/_assets/icon/fsharp-logo.svg/_assets/icon/visualbasic-logo.svgAlso applies to: 100-111, 207-218
About
Improve presentation for popular business languages.
Preview