Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Oct 7, 2025

@amotl amotl added refactoring Changing shape or layout, or moving content around. guidance Matters of layout, shape, and structure. labels Oct 7, 2025
@amotl amotl marked this pull request as ready for review October 7, 2025 11:37
Copy link

coderabbitai bot commented Oct 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Adds new external link anchors to the shared links include and restructures multiple documentation pages. The connect index is reorganized with updated rubrics and references. Three “start/query” pages replace prior grid/rubric layouts with a unified “Further reading” card-based section. No public APIs changed.

Changes

Cohort / File(s) Summary
Links include updates
docs/_include/links.md
Adds new external link definitions (e.g., ADBC, JDBC/ODBC, protocols, SQL, examples) without modifying existing anchors.
Connect index restructuring
docs/connect/index.md
Renames “Reference Manual” to “Reference”; removes “Protocols and API Standards” rubric; re-groups links under “Reference” and new “Related” section; adjusts/removes several external references.
Start/query pages: layout overhaul
docs/start/query/ad-hoc.md, docs/start/query/aggregations.md, docs/start/query/ai-integration.md
Replaces prior grid/rubric sections with a “Further reading” area using grid-item-card groups; updates and relocates associated references; core narrative content retained.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • bmunkholm
  • kneth

Poem

A hop, a skip, I tidy the trails,
Cards now guide where the old list fails.
Links sprout fresh like clover in spring,
“Further reading” is the tune I sing.
With whiskers twitching, docs align—
Thump of approval: everything’s fine. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately summarizes the primary change—relocating reference links in learning path sections—without extraneous details or ambiguity, making it clear to reviewers and maintainers what the pull request accomplishes.
Description Check ✅ Passed The pull request description directly relates to the changeset by explaining that reference links in learning path sections are being relocated to the bottom of the page and provides preview links and issue references, demonstrating relevance and context.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 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 660d81c and ed44445.

📒 Files selected for processing (5)
  • docs/_include/links.md (5 hunks)
  • docs/connect/index.md (1 hunks)
  • docs/start/query/ad-hoc.md (1 hunks)
  • docs/start/query/aggregations.md (1 hunks)
  • docs/start/query/ai-integration.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.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the learning-path-relocate-reference-links branch from d0dab86 to dff9963 Compare October 7, 2025 11:45
@amotl amotl requested review from bmunkholm, kneth and surister October 7, 2025 11:45
@amotl amotl force-pushed the learning-path-relocate-reference-links branch from dff9963 to 660d81c Compare October 7, 2025 11:48
@amotl amotl force-pushed the learning-path-relocate-reference-links branch from 660d81c to ed44445 Compare October 7, 2025 17:38
@amotl amotl merged commit 94dfc73 into main Oct 7, 2025
1 of 3 checks passed
@amotl amotl deleted the learning-path-relocate-reference-links branch October 7, 2025 17:39
[HNSW paper]: https://arxiv.org/pdf/1603.09320
[HoloViews]: https://www.holoviews.org/
[HoloViz]: https://holoviz.org/
[HTTP protocol]: https://en.wikipedia.org/wiki/HTTP
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be removed as we are not using it anywhere (and I also don't think we should).

[Replicating CDC events from DynamoDB to CrateDB]: https://cratedb.com/blog/replicating-cdc-events-from-dynamodb-to-cratedb
[Replicating CDC events to CrateDB using AWS DMS]: https://cratedb.com/blog/replicating-cdc-events-to-cratedb-using-aws-dms
[Replicating data to CrateDB with Debezium and Kafka]: https://community.cratedb.com/t/replicating-data-to-cratedb-with-debezium-and-kafka/1388
[SQL]: https://en.wikipedia.org/wiki/Sql
Copy link
Contributor

Choose a reason for hiding this comment

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

Same - remove?

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

Labels

guidance Matters of layout, shape, and structure. refactoring Changing shape or layout, or moving content around.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants