Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Sep 23, 2025

Just a small fix.

Apparently, the Sphinx link checker currently does not scan Markdown
By-Reference links [1]. Why?

[1] https://www.ii.com/links-footnotes-markdown/
@amotl amotl added the maintenance C'est la vie. label Sep 23, 2025
Copy link

coderabbitai bot commented Sep 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation edits only: updated wording and references in drivers guide, and reworked labels/sections and reference links on the connect index page. No code, APIs, or functional changes.

Changes

Cohort / File(s) Summary
Docs: Drivers page updates
docs/connect/drivers.md
Expanded intro sentences clarifying use of CrateDB PostgreSQL/HTTP interfaces; added trailing blank lines; appended reference links for HTTP and PostgreSQL interfaces.
Docs: Connect index rework
docs/connect/index.md
Renamed grid card to “Overview: connect-drivers”; added two new section blocks (“Database connectivity options and tools.” and “Database driver connection examples.”); removed two specific reference entries and kept consolidated links.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

guidance

Suggested reviewers

  • surister
  • karynzv
  • hammerhead

Poem

A nibble of docs, a hop through the guide,
I thump out the links, aligned side by side.
PostgreSQL paths and HTTP trails,
Carrots of clarity tucked in the details.
With paws on the index, I tidy the lanes—
Connections now crisp, with well-marked domains. 🥕

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-connect

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 222da4c and 565cf96.

📒 Files selected for processing (2)
  • docs/connect/drivers.md (4 hunks)
  • docs/connect/index.md (1 hunks)

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 changed the title Drivers: Fix broken links Drivers: Fix broken links. Improve wording. Sep 23, 2025
@amotl amotl marked this pull request as ready for review September 23, 2025 18:47
@amotl amotl merged commit 5d1d2df into main Sep 23, 2025
3 checks passed
@amotl amotl deleted the fix-connect branch September 23, 2025 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant