Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 29, 2025

About

Just a bit of copy editing about layout, also tuning down card representations a bit more, for saving screen space on index pages, and improving user guidance.

Preview

Review

The patch does not include any complexities or many words to review, so the review is merely asking about your opinion if you think the page is reasonably appealing. Please share any suggestions to improve.

References

/cc @karynzv, @hammerhead, @surister, @zolbatar, @grbade

@amotl amotl added sanding-1200 Fine sanding. guidance Matters of layout, shape, and structure. labels Oct 29, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 29, 2025

Walkthrough

The pull request updates documentation navigation by adding an "Integrate" grid-item-card to the handbook's "See also" section and restructuring the index homepage layout. The index replaces the existing 4-card grid with a new Quick links section containing a 2x2x2 grid and an enhanced CrateDB Cloud start section with button reference blocks.

Changes

Cohort / File(s) Summary
Documentation navigation updates
docs/handbook/index.md
Adds new grid-item-card entry for "Integrate" under "See also" section with description linking to third-party integrations.
Homepage restructuring
docs/index.md
Replaces original 4-card grid layout (Getting started, Connect, Integrate, CrateDB Cloud starter) with new Quick links section featuring a 2x2x2 grid (Getting started, Connect, Handbook) plus enhanced CrateDB Cloud card with arrow icon. Introduces new Start section with button-ref block for CrateDB Cloud.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Changes are limited to documentation content and navigation structure with no code logic modifications
  • Updates follow existing patterns and conventions for grid-item-cards and layout sections
  • Primary focus: verify visual layout consistency, link accuracy, and navigation hierarchy

Possibly related PRs

  • crate/cratedb-guide#446: Modifies the same documentation files with adjustments to grid/card entries and Quick links layout
  • crate/cratedb-guide#364: Updates docs/handbook/index.md navigation grid with grid-item-card rearrangements including Integrate and Connect entries
  • crate/cratedb-guide#369: Modifies both docs/index.md and docs/handbook/index.md with navigation and card layout updates

Suggested reviewers

  • kneth
  • bmunkholm
  • surister

Poem

🐰 Cards shuffled with care, a hop and a bound,
Quick links now arranged on documentation ground,
Integrate joins the chorus, new paths to explore,
Navigation grows richer, we open more doors!
Hop, hop, hooray! The docs dance once more

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Welcome: Tune down quick links" directly relates to the primary change in the changeset. The raw summary indicates the main modification is in docs/index.md, where the original 4-card grid layout is replaced with a new "Quick links" layout structure containing a 2x2x2 grid of cards. The phrase "tune down" accurately conveys the nature of this adjustment to the quick links section, making the title clear, specific, and aligned with the most significant change from the developer's perspective.
Description Check ✅ Passed The pull request description describes copy editing changes about layout and tuning down card representations to save screen space on index pages. This directly aligns with the changeset, which modifies docs/index.md by replacing a 4-card grid layout with a new Quick links structure and reorganizing card representations, and modifies docs/handbook/index.md by adding new navigation items under the "See also" section. The description provides relevant context about the nature of the changes and includes preview links and references to related issues, demonstrating that the author has articulated how the changes relate to layout improvements and user guidance.
✨ 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 welcome-more

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 requested review from matriv and seut October 29, 2025 23:44
Copy link
Member

@seut seut left a comment

Choose a reason for hiding this comment

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

thx!

@amotl amotl merged commit 791b13d into main Oct 30, 2025
2 of 3 checks passed
@amotl amotl deleted the welcome-more branch October 30, 2025 09:10
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. sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants