Connect: Improve guidance re. learning path and reference styles

[amotl]

About

Improve guidance on "Connect" index page by effectively pushing all the details to the bottom. In this case it fits both "learning path" and "reference material" styles at the same time.

Preview

• https://cratedb-guide--383.org.readthedocs.build/connect/

References

• Documentation UX: Reconsider placement and handling of reference links #372

[coderabbitai]

Walkthrough

Rewrites and restructures docs/connect/index.md: replaces the initial grid-based intro with concise text, reorganizes sections into Get started, Drivers by language, Protocol Support, Further reading, and Read more, updates toctrees and cards, and consolidates/relocates protocol and navigation content.

Changes

Cohort / File(s)	Change summary
Docs: Connect page restructuring docs/connect/index.md	Replaced grid/rubric intro with simplified text; reorganized Overview into Get started; added Drivers by language grid; duplicated/relocated Protocol Support into a dedicated block; added Further reading and Read more card grids; updated toctrees and references; removed prior grid-item wrappers and adjusted wording for driver-specific URIs/properties.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Navigation: Relocate reference links in learning path sections #379 — Similar reorganization of docs/connect/index.md references and protocol blocks.
• Connect: Improve index page #231 — Simplifies intro and consolidates driver/connection sections in the same file.
• Connect: Reorganize and clean up section #361 — Overlapping structural changes to Connect/Drivers layout and Get started content.

Suggested labels

refactoring

Suggested reviewers

• bmunkholm
• kneth
• surister

Poem

I hop between cards, neat rows in a field,
Burrows of links where guidance is revealed.
Get started? This way—thump, thump—let’s go!
Drivers in a grid, all lined in a row.
Protocol paths, carrots of lore—
Read more, explore, then bounce for more! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly conveys that the Connect index page guidance is being improved with respect to learning paths and reference styles, which aligns with the PR’s documented goal of reorganizing and simplifying content on that page. It directly references the main change without extraneous details or misleading terms. The phrasing is clear and concise, giving reviewers immediate context about the focus of the update.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The PR description clearly outlines the intention to improve guidance on the Connect index page by moving detailed information to the bottom, matching the documented restructuring and reorganization of content into modular sections. It references both learning path and reference material styles, which aligns with the changes to a card-based layout and reordered subsections. The included preview link and reference to GH-372 further confirm its relevance to the changeset.

✨ 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 connect-guidance

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}